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.308.1

Browse Source
This commit is contained in:
speakeasybot
2024-06-15 00:11:20 +00:00
parent 3a2e7307a0
commit ed203455dd
72 changed files with 1768 additions and 514 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -8,9 +8,44 @@ API Calls that perform operations directly against https://Plex.tv
### Available Operations
* [get_home_data](#get_home_data) - Get Plex Home Data
* [get_pin](#get_pin) - Get a Pin
* [get_token](#get_token) - Get Access Token
## get_home_data
Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status.
### Example Usage
```ruby
require 'plexruby'
s = ::OpenApiSDK::PlexAPI.new(
x_plex_client_identifier: "Postman",
)
s.config_security(
::OpenApiSDK::Shared::Security.new(
access_token: "<YOUR_API_KEY_HERE>",
)
)
res = s.plex.get_home_data()
if ! res.two_hundred_application_json_object.nil?
# handle response
end
```
### Response
**[T.nilable(::OpenApiSDK::Operations::GetHomeDataResponse)](../../models/operations/gethomedataresponse.md)**
## get_pin
Retrieve a Pin from Plex.tv for authentication flows
@@ -26,9 +61,9 @@ s = ::OpenApiSDK::PlexAPI.new(
)
res = s.plex.get_pin(strong=false, x_plex_client_identifier="Postman")
res = s.plex.get_pin(x_plex_product="Postman", strong=false, x_plex_client_identifier="Postman")
if ! res.two_hundred_application_json_object.nil?
if ! res.two_hundred_and_one_application_json_object.nil?
# handle response
end
@@ -38,6 +73,7 @@ end
| Parameter | 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::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/> | Postman |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
@@ -65,7 +101,7 @@ s = ::OpenApiSDK::PlexAPI.new(
res = s.plex.get_token(pin_id="<value>", x_plex_client_identifier="Postman")
if res.status_code == 200
if ! res.two_hundred_application_json_object.nil?
# handle response
end