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 0.0.3, Speakeasy CLI 1.158.0

Browse Source
This commit is contained in:
speakeasybot
2024-01-31 15:06:11 +00:00
parent 658f41b15a
commit dc52ab29b3
532 changed files with 211976 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
docs/sdks/plextv/README.md Normal file
View File

@@ -0,0 +1,87 @@
# PlexTv
### Available Operations
* [get_pin](#get_pin) - Get a Pin
* [get_token](#get_token) - Get Access Token
## get_pin
Retrieve a Pin from Plex.tv for authentication flows
### Example Usage
```ruby
require_relative plexruby
s = ::OpenApiSDK::PlexAPI.new
s.config_security(
security=Shared::Security.new(
access_token="<YOUR_API_KEY_HERE>",
)
)
res = s.plex_tv.get_pin(x_plex_client_identifier="string", strong=false)
if ! res.two_hundred_application_json_object.nil?
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *String* | :heavy_check_mark: | Plex Authentication Token |
| `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/> |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[T.nilable(Operations::GetPinResponse)](../../models/operations/getpinresponse.md)**
## get_token
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
### Example Usage
```ruby
require_relative plexruby
s = ::OpenApiSDK::PlexAPI.new
s.config_security(
security=Shared::Security.new(
access_token="<YOUR_API_KEY_HERE>",
)
)
res = s.plex_tv.get_token(pin_id="string", x_plex_client_identifier="string")
if res.status == 200
# handle response
end
```
### Parameters
| 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: | Plex Authentication Token |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[T.nilable(Operations::GetTokenResponse)](../../models/operations/gettokenresponse.md)**