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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.228.1

Browse Source
This commit is contained in:
speakeasybot
2024-03-29 16:37:24 +00:00
parent 8957a8d350
commit 5f55e68f22
43 changed files with 360 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -21,10 +21,12 @@ Retrieve a Pin from Plex.tv for authentication flows
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "<value>",
)
res = s.plex.get_pin(x_plex_client_identifier="<value>", strong=false)
res = s.plex.get_pin(strong=false, x_plex_client_identifier="<value>")
if ! res.two_hundred_application_json_object.nil?
# handle response
@@ -36,8 +38,8 @@ end
| Parameter | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *::String* | :heavy_check_mark: | 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/> |
| `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/> |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. |
@@ -56,7 +58,9 @@ Retrieve an Access Token from Plex.tv after the Pin has already been authenticat
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "<value>",
)
res = s.plex.get_token(pin_id="<value>", x_plex_client_identifier="<value>")
@@ -72,7 +76,7 @@ end
| Parameter | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *::String* | :heavy_check_mark: | The PinID to retrieve an access token for |
| `x_plex_client_identifier` | *::String* | :heavy_check_mark: | 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/> |
| `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/> |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. |