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

12
docs/sdks/activities/README.md
View File

@@ -27,7 +27,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -62,7 +66,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

28
docs/sdks/authentication/README.md
View File

@@ -24,7 +24,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -68,7 +72,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -109,7 +117,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -150,11 +162,15 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
res = s.authentication.post_users_sign_in_data(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", request_body=::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(
res = s.authentication.post_users_sign_in_data(client_id="gcgzw5rz2xovp84b4vha3a40", request_body=::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(
login: "username@email.com",
password: "password123",
verification_code: "123456",
@@ -170,7 +186,7 @@ end
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *::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` | *::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` | [::PlexRubySDK::Operations::PostUsersSignInDataRequestBody](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |

30
docs/sdks/butler/README.md
View File

@@ -24,7 +24,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -64,7 +68,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -100,7 +108,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -140,7 +152,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -182,7 +198,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

12
docs/sdks/hubs/README.md
View File

@@ -21,7 +21,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -64,7 +68,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

72
docs/sdks/library/README.md
View File

@@ -31,7 +31,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -74,7 +78,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -122,7 +130,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -196,7 +208,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -238,7 +254,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -299,7 +319,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -351,7 +375,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -411,7 +439,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -454,7 +486,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -496,7 +532,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -539,7 +579,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -582,7 +626,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

18
docs/sdks/log/README.md
View File

@@ -23,7 +23,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -87,7 +91,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -133,7 +141,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

30
docs/sdks/media/README.md
View File

@@ -24,7 +24,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -65,7 +69,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -107,7 +115,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -150,7 +162,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -200,7 +216,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

54
docs/sdks/playlists/README.md
View File

@@ -34,7 +34,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -82,7 +86,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -126,7 +134,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -168,7 +180,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -210,7 +226,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -257,7 +277,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -300,7 +324,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -343,7 +371,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -387,7 +419,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

66
docs/sdks/plex/README.md
View File

@@ -26,7 +26,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -67,7 +71,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -108,7 +116,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
@@ -144,7 +156,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -179,7 +195,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -188,7 +208,7 @@ s.config_security(
)
res = s.plex.get_server_resources(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", include_https=::PlexRubySDK::Operations::IncludeHttps::ONE, include_relay=::PlexRubySDK::Operations::IncludeRelay::ONE, include_i_pv6=::PlexRubySDK::Operations::IncludeIPv6::ONE)
res = s.plex.get_server_resources(client_id="gcgzw5rz2xovp84b4vha3a40", include_https=::PlexRubySDK::Operations::IncludeHttps::ONE, include_relay=::PlexRubySDK::Operations::IncludeRelay::ONE, include_i_pv6=::PlexRubySDK::Operations::IncludeIPv6::ONE)
if ! res.plex_devices.nil?
# handle response
@@ -200,7 +220,7 @@ end
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *::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` | *::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` | [::PlexRubySDK::Operations::IncludeHttps](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [::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` | [::PlexRubySDK::Operations::IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
@@ -215,7 +235,7 @@ end
## get_pin
Retrieve a Pin from Plex.tv for authentication flows
Retrieve a Pin ID from Plex.tv to use for authentication flows
### Example Usage
@@ -224,11 +244,17 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
req = ::PlexRubySDK::Operations::GetPinRequest.new()
res = s.plex.get_pin(strong=false, x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", x_plex_product="Plex Web")
res = s.plex.get_pin(req)
if ! res.auth_pin_container.nil?
# handle response
@@ -238,12 +264,10 @@ end
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *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` | *::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` | *::String* | :heavy_minus_sign: | N/A | Plex Web |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `request` | [::PlexRubySDK::Operations::GetPinRequest](../../models/operations/getpinrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
@@ -263,11 +287,15 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
res = s.plex.get_token_by_pin_id(pin_id=408895, x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40")
res = s.plex.get_token_by_pin_id(pin_id=408895, client_id="gcgzw5rz2xovp84b4vha3a40")
if ! res.auth_pin_container.nil?
# handle response
@@ -280,7 +308,7 @@ end
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `x_plex_client_identifier` | *::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` | *::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 |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response

18
docs/sdks/search/README.md
View File

@@ -34,7 +34,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -81,7 +85,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -124,7 +132,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

54
docs/sdks/server/README.md
View File

@@ -28,7 +28,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -63,7 +67,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -98,7 +106,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -133,7 +145,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -168,7 +184,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
@@ -198,7 +218,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -234,7 +258,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -285,7 +313,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -326,7 +358,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

24
docs/sdks/sessions/README.md
View File

@@ -23,7 +23,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -58,7 +62,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -102,7 +110,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -137,7 +149,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

18
docs/sdks/statistics/README.md
View File

@@ -22,7 +22,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -63,7 +67,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -104,7 +112,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

18
docs/sdks/updater/README.md
View File

@@ -23,7 +23,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -58,7 +62,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -100,7 +108,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

12
docs/sdks/video/README.md
View File

@@ -21,7 +21,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(
@@ -75,7 +79,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(

6
docs/sdks/watchlist/README.md
View File

@@ -20,7 +20,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new(
x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
client_id: "gcgzw5rz2xovp84b4vha3a40",
client_name: "Plex Web",
client_version: "4.133.0",
client_platform: "Chrome",
device_name: "Linux",
)
s.config_security(
::PlexRubySDK::Shared::Security.new(