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

21
.speakeasy/gen.lock
View File

@@ -1,12 +1,12 @@
lockVersion: 2.0.0 lockVersion: 2.0.0
id: aa9449e7-c19d-411d-b8e2-f9c5fe982f6f id: aa9449e7-c19d-411d-b8e2-f9c5fe982f6f
management: management:
docChecksum: a6fee1797b2da7ccbaf7743772a40b56 docChecksum: 5bf578a672589649d8ed83c3927c50a6
docVersion: 0.0.3 docVersion: 0.0.3
speakeasyVersion: 1.397.2 speakeasyVersion: 1.399.2
generationVersion: 2.415.8 generationVersion: 2.416.6
releaseVersion: 0.3.5 releaseVersion: 0.3.6
configChecksum: b47335363281cb2bc91347ed8463cbdf configChecksum: 3b44a7466c2af554cbf3dbe5d439f554
repoURL: https://github.com/LukeHagar/plexruby.git repoURL: https://github.com/LukeHagar/plexruby.git
repoSubDirectory: . repoSubDirectory: .
installationURL: https://github.com/LukeHagar/plexruby installationURL: https://github.com/LukeHagar/plexruby
@@ -1544,7 +1544,7 @@ examples:
width: 110 width: 110
height: 165 height: 165
opacity: 643869 opacity: 643869
blur: 4000 blur: 20
minSize: 0 minSize: 0
upscale: 0 upscale: 0
url: "/library/metadata/49564/thumb/1654258204" url: "/library/metadata/49564/thumb/1654258204"
@@ -1768,7 +1768,7 @@ examples:
speakeasy-default-get-geo-data: speakeasy-default-get-geo-data:
responses: responses:
"200": "200":
application/json: {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"} application/json: {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": "802", "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}
"400": "400":
application/json: {"errors": []} application/json: {"errors": []}
"401": "401":
@@ -1800,12 +1800,17 @@ examples:
"": "":
parameters: parameters:
query: query:
X-Plex-Product: "Plex Web" X-Plex-Product: Plex Web
X-Plex-Device: Linux
X-Plex-Version: 4.133.0
X-Plex-Platform: Chrome
responses: responses:
"200": "200":
application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null} application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null}
"400": "400":
application/json: {"errors": []} application/json: {"errors": []}
"201":
application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": "802", "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null}
getTokenByPinId: getTokenByPinId:
"": "":
parameters: parameters:

2
.speakeasy/gen.yaml
View File

@@ -12,7 +12,7 @@ generation:
auth: auth:
oAuth2ClientCredentialsEnabled: false oAuth2ClientCredentialsEnabled: false
ruby: ruby:
version: 0.3.5 version: 0.3.6
author: LukeHagar author: LukeHagar
description: Ruby Client SDK Generated by Speakeasy description: Ruby Client SDK Generated by Speakeasy
imports: imports:

12
.speakeasy/workflow.lock
View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.397.2 speakeasyVersion: 1.399.2
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -9,8 +9,8 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:533fe97486e3fe2d84e890b7bbcdba4543d415e45181386154e011861f6da36f sourceRevisionDigest: sha256:327e4a83099f910e042784ecc571fcbc4c9a6d8ba169b4ba181afb890a9936cc
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9 sourceBlobDigest: sha256:a652fa39754f0c22a1454f628fe84983b34662ee8a153a3461d50b833f8bc5c2
tags: tags:
- latest - latest
- main - main
@@ -18,10 +18,10 @@ targets:
plexruby: plexruby:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:533fe97486e3fe2d84e890b7bbcdba4543d415e45181386154e011861f6da36f sourceRevisionDigest: sha256:327e4a83099f910e042784ecc571fcbc4c9a6d8ba169b4ba181afb890a9936cc
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9 sourceBlobDigest: sha256:a652fa39754f0c22a1454f628fe84983b34662ee8a153a3461d50b833f8bc5c2
codeSamplesNamespace: code-samples-ruby-plexruby codeSamplesNamespace: code-samples-ruby-plexruby
codeSamplesRevisionDigest: sha256:528ed89116bd86753ee769183367924a5a991630b7cd609339b283e1bcbda236 codeSamplesRevisionDigest: sha256:aa70f369f486c22141bde07afc10cf8683baa78e37f3d955c9fd856af52b01ac
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest

2
Gemfile.lock
View File

@@ -1,7 +1,7 @@
PATH PATH
remote: . remote: .
specs: specs:
plex_ruby_sdk (0.3.5) plex_ruby_sdk (0.3.6)
faraday faraday
faraday-multipart faraday-multipart
rack rack

32
README.md
View File

@@ -43,7 +43,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -228,7 +232,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -249,21 +257,25 @@ end
<!-- Start Global Parameters [global-parameters] --> <!-- Start Global Parameters [global-parameters] -->
## Global Parameters ## Global Parameters
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_server_resources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_server_resources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
### Available Globals ### Available Globals
The following global parameter is available. The following global parameters are available.
| Name | Type | Required | Description | | Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- | | ---- | ---- |:--------:| ----------- |
| x_plex_client_identifier | ::String | | The unique identifier for the client application | client_id | ::String | | The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
| |
| client_name | ::String | | The client_name parameter. |
| client_version | ::String | | The client_version parameter. |
| client_platform | ::String | | The client_platform parameter. |
| device_name | ::String | | The device_name parameter. |
### Example ### Example
@@ -273,7 +285,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -282,7 +298,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? if ! res.plex_devices.nil?
# handle response # handle response

12
RELEASES.md
View File

@@ -526,4 +526,14 @@ Based on:
### Generated ### Generated
- [ruby v0.3.5] . - [ruby v0.3.5] .
### Releases ### Releases
- [Ruby Gems v0.3.5] https://rubygems.org/gems/plex_ruby_sdk/versions/0.3.5 - . - [Ruby Gems v0.3.5] https://rubygems.org/gems/plex_ruby_sdk/versions/0.3.5 - .
## 2024-09-19 00:07:33
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.399.2 (2.416.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [ruby v0.3.6] .
### Releases
- [Ruby Gems v0.3.6] https://rubygems.org/gems/plex_ruby_sdk/versions/0.3.6 - .

6
USAGE.md
View File

@@ -4,7 +4,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

148
codeSamples.yaml
View File

@@ -8,442 +8,442 @@ actions:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getServerCapabilities label: getServerCapabilities
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_capabilities()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_capabilities()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/:/prefs"]["get"] - target: $["paths"]["/:/prefs"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getServerPreferences label: getServerPreferences
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_preferences()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_preferences()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/:/progress"]["post"] - target: $["paths"]["/:/progress"]["post"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: updatePlayProgress label: updatePlayProgress
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.update_play_progress(key=\"<key>\", time=90000.0, state=\"played\")\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.update_play_progress(key=\"<key>\", time=90000.0, state=\"played\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/:/scrobble"]["get"] - target: $["paths"]["/:/scrobble"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: markPlayed label: markPlayed
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_played(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_played(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/:/timeline"]["get"] - target: $["paths"]["/:/timeline"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getTimeline label: getTimeline
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetTimelineRequest.new(\n rating_key: 23409.0,\n key: \"/library/metadata/23409\",\n state: ::PlexRubySDK::Operations::State::PLAYING,\n has_mde: 1.0,\n time: 2000.0,\n duration: 10000.0,\n context: \"home:hub.continueWatching\",\n play_queue_item_id: 1.0,\n play_back_time: 2000.0,\n row: 1.0,\n)\n \nres = s.video.get_timeline(req)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetTimelineRequest.new(\n rating_key: 23409.0,\n key: \"/library/metadata/23409\",\n state: ::PlexRubySDK::Operations::State::PLAYING,\n has_mde: 1.0,\n time: 2000.0,\n duration: 10000.0,\n context: \"home:hub.continueWatching\",\n play_queue_item_id: 1.0,\n play_back_time: 2000.0,\n row: 1.0,\n)\n \nres = s.video.get_timeline(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/:/unscrobble"]["get"] - target: $["paths"]["/:/unscrobble"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: markUnplayed label: markUnplayed
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_unplayed(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.media.mark_unplayed(key=59398.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/activities"]["get"] - target: $["paths"]["/activities"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getServerActivities label: getServerActivities
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.get_server_activities()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.get_server_activities()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/activities/{activityUUID}"]["delete"] - target: $["paths"]["/activities/{activityUUID}"]["delete"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: cancelServerActivities label: cancelServerActivities
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.cancel_server_activities(activity_uuid=\"25b71ed5-0f9d-461c-baa7-d404e9e10d3e\")\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.activities.cancel_server_activities(activity_uuid=\"25b71ed5-0f9d-461c-baa7-d404e9e10d3e\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler"]["delete"] - target: $["paths"]["/butler"]["delete"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: stopAllTasks label: stopAllTasks
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_all_tasks()\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler"]["get"] - target: $["paths"]["/butler"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getButlerTasks label: getButlerTasks
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.get_butler_tasks()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.get_butler_tasks()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/butler"]["post"] - target: $["paths"]["/butler"]["post"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: startAllTasks label: startAllTasks
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_all_tasks()\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_all_tasks()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler/{taskName}"]["delete"] - target: $["paths"]["/butler/{taskName}"]["delete"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: stopTask label: stopTask
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_task(task_name=::PlexRubySDK::Operations::PathParamTaskName::BACKUP_DATABASE)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.stop_task(task_name=::PlexRubySDK::Operations::PathParamTaskName::BACKUP_DATABASE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/butler/{taskName}"]["post"] - target: $["paths"]["/butler/{taskName}"]["post"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: startTask label: startTask
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_task(task_name=::PlexRubySDK::Operations::TaskName::CLEAN_OLD_BUNDLES)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.butler.start_task(task_name=::PlexRubySDK::Operations::TaskName::CLEAN_OLD_BUNDLES)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/clients"]["get"] - target: $["paths"]["/clients"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getAvailableClients label: getAvailableClients
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_available_clients()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_available_clients()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/companions"]["get"] - target: $["paths"]["/companions"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getCompanionsData label: getCompanionsData
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_companions_data()\n\nif ! res.response_bodies.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_companions_data()\n\nif ! res.response_bodies.nil?\n # handle response\nend"
- target: $["paths"]["/devices"]["get"] - target: $["paths"]["/devices"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getDevices label: getDevices
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_devices()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_devices()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/friends"]["get"] - target: $["paths"]["/friends"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getUserFriends label: getUserFriends
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_user_friends()\n\nif ! res.friends.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_user_friends()\n\nif ! res.friends.nil?\n # handle response\nend"
- target: $["paths"]["/geoip"]["get"] - target: $["paths"]["/geoip"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getGeoData label: getGeoData
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.plex.get_geo_data()\n\nif ! res.geo_data.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\n\n \nres = s.plex.get_geo_data()\n\nif ! res.geo_data.nil?\n # handle response\nend"
- target: $["paths"]["/home"]["get"] - target: $["paths"]["/home"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getHomeData label: getHomeData
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_home_data()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.plex.get_home_data()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/hubs"]["get"] - target: $["paths"]["/hubs"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getGlobalHubs label: getGlobalHubs
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_global_hubs(count=1262.49, only_transient=::PlexRubySDK::Operations::OnlyTransient::ONE)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_global_hubs(count=1262.49, only_transient=::PlexRubySDK::Operations::OnlyTransient::ONE)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/hubs/search"]["get"] - target: $["paths"]["/hubs/search"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: performSearch label: performSearch
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_search(query=\"arnold\", section_id=9372.7, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_search(query=\"arnold\", section_id=9372.7, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/hubs/search/voice"]["get"] - target: $["paths"]["/hubs/search/voice"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: performVoiceSearch label: performVoiceSearch
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_voice_search(query=\"dead+poop\", section_id=4094.8, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.perform_voice_search(query=\"dead+poop\", section_id=4094.8, limit=5.0)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/hubs/sections/{sectionId}"]["get"] - target: $["paths"]["/hubs/sections/{sectionId}"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getLibraryHubs label: getLibraryHubs
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_library_hubs(section_id=6728.76, count=9010.22, only_transient=::PlexRubySDK::Operations::QueryParamOnlyTransient::ZERO)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.hubs.get_library_hubs(section_id=6728.76, count=9010.22, only_transient=::PlexRubySDK::Operations::QueryParamOnlyTransient::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/identity"]["get"] - target: $["paths"]["/identity"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: identity label: identity
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.server.get_server_identity()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\n\n \nres = s.server.get_server_identity()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/all/top"]["get"] - target: $["paths"]["/library/all/top"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getTopWatchedContent label: getTopWatchedContent
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_top_watched_content(type=::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType::TWO, include_guids=1)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_top_watched_content(type=::PlexRubySDK::Operations::GetTopWatchedContentQueryParamType::TWO, include_guids=1)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/hashes"]["get"] - target: $["paths"]["/library/hashes"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getFileHash label: getFileHash
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_file_hash(url=\"file://C:\\Image.png&type=13\", type=4462.17)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_file_hash(url=\"file://C:\\Image.png&type=13\", type=4462.17)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}"]["get"] - target: $["paths"]["/library/metadata/{ratingKey}"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: key label: key
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_meta_data_by_rating_key(rating_key=9518)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_meta_data_by_rating_key(rating_key=9518)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"] - target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: image label: image
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetBannerImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_banner_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetBannerImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_banner_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"] - target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getMetadataChildren label: getMetadataChildren
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_metadata_children(rating_key=1539.14, include_elements=\"<value>\")\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_metadata_children(rating_key=1539.14, include_elements=\"<value>\")\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"] - target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: image label: image
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetThumbImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_thumb_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetThumbImageRequest.new(\n rating_key: 9518,\n width: 396,\n height: 396,\n min_size: 1,\n upscale: 1,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.media.get_thumb_image(req)\n\nif ! res.bytes.nil?\n # handle response\nend"
- target: $["paths"]["/library/onDeck"]["get"] - target: $["paths"]["/library/onDeck"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getOnDeck label: getOnDeck
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_on_deck()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_on_deck()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/recentlyAdded"]["get"] - target: $["paths"]["/library/recentlyAdded"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getRecentlyAdded label: getRecentlyAdded
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_recently_added(x_plex_container_start=0, x_plex_container_size=50)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_recently_added(x_plex_container_start=0, x_plex_container_size=50)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections"]["get"] - target: $["paths"]["/library/sections"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: libraries label: libraries
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_all_libraries()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_all_libraries()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/watchlist/{filter}"]["get"] - target: $["paths"]["/library/sections/watchlist/{filter}"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: list label: list
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetWatchListRequest.new(\n filter: ::PlexRubySDK::Operations::Filter::AVAILABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.watchlist.get_watch_list(req)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetWatchListRequest.new(\n filter: ::PlexRubySDK::Operations::Filter::AVAILABLE,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n x_plex_token: \"CV5xoxjTpFKUzBTShsaf\",\n)\n \nres = s.watchlist.get_watch_list(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}"]["delete"] - target: $["paths"]["/library/sections/{sectionKey}"]["delete"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: deleteLibrary label: deleteLibrary
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.delete_library(section_key=9518)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.delete_library(section_key=9518)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}"]["get"] - target: $["paths"]["/library/sections/{sectionKey}"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: details label: details
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_library_details(section_key=9518, include_details=::PlexRubySDK::Operations::IncludeDetails::ZERO)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_library_details(section_key=9518, include_details=::PlexRubySDK::Operations::IncludeDetails::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"] - target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: metadata label: metadata
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_refresh_library_metadata(section_key=9518, force=::PlexRubySDK::Operations::Force::ONE)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_refresh_library_metadata(section_key=9518, force=::PlexRubySDK::Operations::Force::ONE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}/search"]["get"] - target: $["paths"]["/library/sections/{sectionKey}/search"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: library label: library
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_search_library(section_key=9518, type=::PlexRubySDK::Operations::QueryParamType::TWO)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.library.get_search_library(section_key=9518, type=::PlexRubySDK::Operations::QueryParamType::TWO)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"] - target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: items label: items
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(\n section_key: 9518,\n tag: ::PlexRubySDK::Operations::Tag::EDITION,\n include_guids: ::PlexRubySDK::Operations::IncludeGuids::ONE,\n include_meta: ::PlexRubySDK::Operations::IncludeMeta::ONE,\n type: ::PlexRubySDK::Operations::Type::TWO,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_library_items(req)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetLibraryItemsRequest.new(\n section_key: 9518,\n tag: ::PlexRubySDK::Operations::Tag::EDITION,\n include_guids: ::PlexRubySDK::Operations::IncludeGuids::ONE,\n include_meta: ::PlexRubySDK::Operations::IncludeMeta::ONE,\n type: ::PlexRubySDK::Operations::Type::TWO,\n x_plex_container_start: 0,\n x_plex_container_size: 50,\n)\n \nres = s.library.get_library_items(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/log"]["get"] - target: $["paths"]["/log"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: logLine label: logLine
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.log_line(level=::PlexRubySDK::Operations::Level::THREE, message=\"Test log message\", source=\"Postman\")\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.log_line(level=::PlexRubySDK::Operations::Level::THREE, message=\"Test log message\", source=\"Postman\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/log"]["post"] - target: $["paths"]["/log"]["post"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: logMultiLine label: logMultiLine
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = \"level=4&message=Test%20message%201&source=postman\nlevel=3&message=Test%20message%202&source=postman\nlevel=1&message=Test%20message%203&source=postman\"\n \nres = s.log.log_multi_line(req)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = \"level=4&message=Test%20message%201&source=postman\nlevel=3&message=Test%20message%202&source=postman\nlevel=1&message=Test%20message%203&source=postman\"\n \nres = s.log.log_multi_line(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/log/networked"]["get"] - target: $["paths"]["/log/networked"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: enablePaperTrail label: enablePaperTrail
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.enable_paper_trail()\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.log.enable_paper_trail()\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/media/providers"]["get"] - target: $["paths"]["/media/providers"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: providers label: providers
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_media_providers(x_plex_token=\"CV5xoxjTpFKUzBTShsaf\")\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_media_providers(x_plex_token=\"CV5xoxjTpFKUzBTShsaf\")\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/myplex/account"]["get"] - target: $["paths"]["/myplex/account"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getMyPlexAccount label: getMyPlexAccount
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_my_plex_account()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_my_plex_account()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/photo/:/transcode"]["get"] - target: $["paths"]["/photo/:/transcode"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getResizedPhoto label: getResizedPhoto
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetResizedPhotoRequest.new(\n width: 110.0,\n height: 165.0,\n opacity: 643869,\n blur: 0.0,\n min_size: ::PlexRubySDK::Operations::MinSize::ZERO,\n upscale: ::PlexRubySDK::Operations::Upscale::ONE,\n url: \"/library/metadata/49564/thumb/1654258204\",\n)\n \nres = s.server.get_resized_photo(req)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::GetResizedPhotoRequest.new(\n width: 110.0,\n height: 165.0,\n opacity: 643869,\n blur: 0.0,\n min_size: ::PlexRubySDK::Operations::MinSize::ZERO,\n upscale: ::PlexRubySDK::Operations::Upscale::ONE,\n url: \"/library/metadata/49564/thumb/1654258204\",\n)\n \nres = s.server.get_resized_photo(req)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/pins"]["post"] - target: $["paths"]["/pins"]["post"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getPin label: getPin
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.plex.get_pin(strong=false, x_plex_client_identifier=\"gcgzw5rz2xovp84b4vha3a40\", x_plex_product=\"Plex Web\")\n\nif ! res.auth_pin_container.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\n\n\nreq = ::PlexRubySDK::Operations::GetPinRequest.new()\n \nres = s.plex.get_pin(req)\n\nif ! res.auth_pin_container.nil?\n # handle response\nend"
- target: $["paths"]["/pins/{pinID}"]["get"] - target: $["paths"]["/pins/{pinID}"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getTokenByPinId label: getTokenByPinId
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.plex.get_token_by_pin_id(pin_id=408895, x_plex_client_identifier=\"gcgzw5rz2xovp84b4vha3a40\")\n\nif ! res.auth_pin_container.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\n\n \nres = s.plex.get_token_by_pin_id(pin_id=408895, client_id=\"gcgzw5rz2xovp84b4vha3a40\")\n\nif ! res.auth_pin_container.nil?\n # handle response\nend"
- target: $["paths"]["/playlists"]["get"] - target: $["paths"]["/playlists"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getPlaylists label: getPlaylists
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlists(playlist_type=::PlexRubySDK::Operations::PlaylistType::AUDIO, smart=::PlexRubySDK::Operations::QueryParamSmart::ZERO)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlists(playlist_type=::PlexRubySDK::Operations::PlaylistType::AUDIO, smart=::PlexRubySDK::Operations::QueryParamSmart::ZERO)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists"]["post"] - target: $["paths"]["/playlists"]["post"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: createPlaylist label: createPlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::CreatePlaylistRequest.new(\n title: \"<value>\",\n type: ::PlexRubySDK::Operations::CreatePlaylistQueryParamType::PHOTO,\n smart: ::PlexRubySDK::Operations::Smart::ONE,\n uri: \"https://inborn-brochure.biz\",\n)\n \nres = s.playlists.create_playlist(req)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::CreatePlaylistRequest.new(\n title: \"<value>\",\n type: ::PlexRubySDK::Operations::CreatePlaylistQueryParamType::PHOTO,\n smart: ::PlexRubySDK::Operations::Smart::ONE,\n uri: \"https://inborn-brochure.biz\",\n)\n \nres = s.playlists.create_playlist(req)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/upload"]["post"] - target: $["paths"]["/playlists/upload"]["post"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: uploadPlaylist label: uploadPlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.upload_playlist(path=\"/home/barkley/playlist.m3u\", force=::PlexRubySDK::Operations::QueryParamForce::ZERO)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.upload_playlist(path=\"/home/barkley/playlist.m3u\", force=::PlexRubySDK::Operations::QueryParamForce::ZERO)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["delete"] - target: $["paths"]["/playlists/{playlistID}"]["delete"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: deletePlaylist label: deletePlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.delete_playlist(playlist_id=216.22)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.delete_playlist(playlist_id=216.22)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["get"] - target: $["paths"]["/playlists/{playlistID}"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getPlaylist label: getPlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist(playlist_id=4109.48)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist(playlist_id=4109.48)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}"]["put"] - target: $["paths"]["/playlists/{playlistID}"]["put"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: updatePlaylist label: updatePlaylist
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.update_playlist(playlist_id=3915, title=\"<value>\", summary=\"<value>\")\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.update_playlist(playlist_id=3915, title=\"<value>\", summary=\"<value>\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}/items"]["delete"] - target: $["paths"]["/playlists/{playlistID}/items"]["delete"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: clearPlaylistContents label: clearPlaylistContents
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.clear_playlist_contents(playlist_id=1893.18)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.clear_playlist_contents(playlist_id=1893.18)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}/items"]["get"] - target: $["paths"]["/playlists/{playlistID}/items"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getPlaylistContents label: getPlaylistContents
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist_contents(playlist_id=5004.46, type=::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType::TWO)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.get_playlist_contents(playlist_id=5004.46, type=::PlexRubySDK::Operations::GetPlaylistContentsQueryParamType::TWO)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/playlists/{playlistID}/items"]["put"] - target: $["paths"]["/playlists/{playlistID}/items"]["put"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: addPlaylistContents label: addPlaylistContents
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.add_playlist_contents(playlist_id=8502.01, uri=\"server://12345/com.plexapp.plugins.library/library/metadata/1\", play_queue_id=123.0)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.playlists.add_playlist_contents(playlist_id=8502.01, uri=\"server://12345/com.plexapp.plugins.library/library/metadata/1\", play_queue_id=123.0)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/resources"]["get"] - target: $["paths"]["/resources"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: resources label: resources
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = 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)\n\nif ! res.plex_devices.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = 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)\n\nif ! res.plex_devices.nil?\n # handle response\nend"
- target: $["paths"]["/search"]["get"] - target: $["paths"]["/search"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getSearchResults label: getSearchResults
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.get_search_results(query=\"110\")\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.search.get_search_results(query=\"110\")\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/security/resources"]["get"] - target: $["paths"]["/security/resources"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getSourceConnectionInformation label: getSourceConnectionInformation
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_source_connection_information(source=\"server://client-identifier\")\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_source_connection_information(source=\"server://client-identifier\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/security/token"]["get"] - target: $["paths"]["/security/token"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getTransientToken label: getTransientToken
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_transient_token(type=::PlexRubySDK::Operations::GetTransientTokenQueryParamType::DELEGATION, scope=::PlexRubySDK::Operations::Scope::ALL)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_transient_token(type=::PlexRubySDK::Operations::GetTransientTokenQueryParamType::DELEGATION, scope=::PlexRubySDK::Operations::Scope::ALL)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/servers"]["get"] - target: $["paths"]["/servers"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getServerList label: getServerList
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_list()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.server.get_server_list()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/statistics/bandwidth"]["get"] - target: $["paths"]["/statistics/bandwidth"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getBandwidthStatistics label: getBandwidthStatistics
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_bandwidth_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_bandwidth_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/statistics/media"]["get"] - target: $["paths"]["/statistics/media"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getStatistics label: getStatistics
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/statistics/resources"]["get"] - target: $["paths"]["/statistics/resources"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getResourcesStatistics label: getResourcesStatistics
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_resources_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.statistics.get_resources_statistics(timespan=4)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/status/sessions"]["get"] - target: $["paths"]["/status/sessions"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getSessions label: getSessions
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_sessions()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_sessions()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/status/sessions/history/all"]["get"] - target: $["paths"]["/status/sessions/history/all"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getSessionHistory label: getSessionHistory
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_session_history(sort=\"<value>\", account_id=1, filter=::PlexRubySDK::Operations::QueryParamFilter.new(), library_section_id=12)\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_session_history(sort=\"<value>\", account_id=1, filter=::PlexRubySDK::Operations::QueryParamFilter.new(), library_section_id=12)\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/transcode/sessions"]["get"] - target: $["paths"]["/transcode/sessions"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getTranscodeSessions label: getTranscodeSessions
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_transcode_sessions()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.get_transcode_sessions()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/transcode/sessions/{sessionKey}"]["delete"] - target: $["paths"]["/transcode/sessions/{sessionKey}"]["delete"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: stopTranscodeSession label: stopTranscodeSession
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.stop_transcode_session(session_key=\"zz7llzqlx8w9vnrsbnwhbmep\")\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.sessions.stop_transcode_session(session_key=\"zz7llzqlx8w9vnrsbnwhbmep\")\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/updater/apply"]["put"] - target: $["paths"]["/updater/apply"]["put"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: applyUpdates label: applyUpdates
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.apply_updates(tonight=::PlexRubySDK::Operations::Tonight::ONE, skip=::PlexRubySDK::Operations::Skip::ONE)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.apply_updates(tonight=::PlexRubySDK::Operations::Tonight::ONE, skip=::PlexRubySDK::Operations::Skip::ONE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/updater/check"]["put"] - target: $["paths"]["/updater/check"]["put"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: checkForUpdates label: checkForUpdates
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.check_for_updates(download=::PlexRubySDK::Operations::Download::ONE)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.check_for_updates(download=::PlexRubySDK::Operations::Download::ONE)\n\nif res.status_code == 200\n # handle response\nend"
- target: $["paths"]["/updater/status"]["get"] - target: $["paths"]["/updater/status"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getUpdateStatus label: getUpdateStatus
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.get_update_status()\n\nif ! res.object.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.updater.get_update_status()\n\nif ! res.object.nil?\n # handle response\nend"
- target: $["paths"]["/user"]["get"] - target: $["paths"]["/user"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: getTokenDetails label: getTokenDetails
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_token_details()\n\nif ! res.user_plex_account.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n \nres = s.authentication.get_token_details()\n\nif ! res.user_plex_account.nil?\n # handle response\nend"
- target: $["paths"]["/users/signin"]["post"] - target: $["paths"]["/users/signin"]["post"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: data label: data
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\n\n \nres = s.authentication.post_users_sign_in_data(x_plex_client_identifier=\"gcgzw5rz2xovp84b4vha3a40\", request_body=::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(\n login: \"username@email.com\",\n password: \"password123\",\n verification_code: \"123456\",\n))\n\nif ! res.user_plex_account.nil?\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\n\n \nres = s.authentication.post_users_sign_in_data(client_id=\"gcgzw5rz2xovp84b4vha3a40\", request_body=::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(\n login: \"username@email.com\",\n password: \"password123\",\n verification_code: \"123456\",\n))\n\nif ! res.user_plex_account.nil?\n # handle response\nend"
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"] - target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: ruby - lang: ruby
label: startUniversalTranscode label: startUniversalTranscode
source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n x_plex_client_identifier: \"gcgzw5rz2xovp84b4vha3a40\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::StartUniversalTranscodeRequest.new(\n has_mde: 1.0,\n path: \"/library/metadata/23409\",\n media_index: 0.0,\n part_index: 0.0,\n protocol: \"hls\",\n fast_seek: 0.0,\n direct_play: 0.0,\n direct_stream: 0.0,\n subtitle_size: 100.0,\n subtites: \"burn\",\n audio_boost: 100.0,\n location: \"lan\",\n media_buffer_size: 102400.0,\n session: \"zvcage8b7rkioqcm8f4uns4c\",\n add_debug_overlay: 0.0,\n auto_adjust_quality: 0.0,\n)\n \nres = s.video.start_universal_transcode(req)\n\nif res.status_code == 200\n # handle response\nend" source: "require 'plex_ruby_sdk'\n\n\ns = ::PlexRubySDK::PlexAPI.new(\n client_id: \"gcgzw5rz2xovp84b4vha3a40\",\n client_name: \"Plex Web\",\n client_version: \"4.133.0\",\n client_platform: \"Chrome\",\n device_name: \"Linux\",\n )\ns.config_security(\n ::PlexRubySDK::Shared::Security.new(\n access_token: \"<YOUR_API_KEY_HERE>\",\n )\n)\n\n\nreq = ::PlexRubySDK::Operations::StartUniversalTranscodeRequest.new(\n has_mde: 1.0,\n path: \"/library/metadata/23409\",\n media_index: 0.0,\n part_index: 0.0,\n protocol: \"hls\",\n fast_seek: 0.0,\n direct_play: 0.0,\n direct_stream: 0.0,\n subtitle_size: 100.0,\n subtites: \"burn\",\n audio_boost: 100.0,\n location: \"lan\",\n media_buffer_size: 102400.0,\n session: \"zvcage8b7rkioqcm8f4uns4c\",\n add_debug_overlay: 0.0,\n auto_adjust_quality: 0.0,\n)\n \nres = s.video.start_universal_transcode(req)\n\nif res.status_code == 200\n # handle response\nend"

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

@@ -13,7 +13,7 @@ Geo location data
| `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam | | `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true | | `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true |
| `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas | | `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *::Integer* | :heavy_check_mark: | The postal code of the location. | 802 | | `postal_code` | *::String* | :heavy_check_mark: | The postal code of the location. | 802 |
| `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true | | `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true |
| `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true | | `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas | | `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |

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

@@ -13,7 +13,7 @@ Geo location data
| `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam | | `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true | | `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true |
| `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas | | `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *::Integer* | :heavy_check_mark: | The postal code of the location. | 802 | | `postal_code` | *::String* | :heavy_check_mark: | The postal code of the location. | 802 |
| `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true | | `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true |
| `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true | | `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas | | `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |

6
docs/models/operations/getpinauthpincontainer.md
View File

@@ -9,13 +9,13 @@ Requests a new pin id used in the authentication flow
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 308667304 | | `id` | *::Integer* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *::String* | :heavy_check_mark: | N/A | 7RQZ | | `code` | *::String* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *::String* | :heavy_check_mark: | N/A | 0 | | `product` | *::String* | :heavy_check_mark: | N/A | Tautulli |
| `trusted` | *T::Boolean* | :heavy_check_mark: | N/A | | | `trusted` | *T::Boolean* | :heavy_check_mark: | N/A | |
| `qr` | *::String* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ | | `qr` | *::String* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `client_identifier` | *::String* | :heavy_check_mark: | The X-Client-Identifier used in the request | | | `client_identifier` | *::String* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [::PlexRubySDK::Operations::GeoData](../../models/operations/geodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} | | `location` | [::PlexRubySDK::Operations::GeoData](../../models/operations/geodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `expires_in` | *::Integer* | :heavy_check_mark: | The number of seconds this pin expires, by default 900 seconds | 876 | | `expires_in` | *::Integer* | :heavy_check_mark: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z | | `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expires_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z | | `expires_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `auth_token` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | | | `auth_token` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `new_registration` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | | | `new_registration` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | |

7
docs/models/operations/getpinrequest.md
View File

@@ -6,5 +6,8 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *T.nilable(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/> | | | `strong` | *T.nilable(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` | *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_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 |
| `x_plex_product` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | Plex Web | | `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/getserverresourcesrequest.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *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_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 |
| `include_https` | [T.nilable(::PlexRubySDK::Operations::IncludeHttps)](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | | `include_https` | [T.nilable(::PlexRubySDK::Operations::IncludeHttps)](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [T.nilable(::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_relay` | [T.nilable(::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` | [T.nilable(::PlexRubySDK::Operations::IncludeIPv6)](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | | `include_i_pv6` | [T.nilable(::PlexRubySDK::Operations::IncludeIPv6)](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |

6
docs/models/operations/gettokenbypinidauthpincontainer.md
View File

@@ -9,13 +9,13 @@ The Pin with a non-null authToken when it has been verified by the user
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | N/A | 308667304 | | `id` | *::Integer* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *::String* | :heavy_check_mark: | N/A | 7RQZ | | `code` | *::String* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *::String* | :heavy_check_mark: | N/A | 0 | | `product` | *::String* | :heavy_check_mark: | N/A | Tautulli |
| `trusted` | *T::Boolean* | :heavy_check_mark: | N/A | | | `trusted` | *T::Boolean* | :heavy_check_mark: | N/A | |
| `qr` | *::String* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ | | `qr` | *::String* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `client_identifier` | *::String* | :heavy_check_mark: | The X-Client-Identifier used in the request | | | `client_identifier` | *::String* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [::PlexRubySDK::Operations::GetTokenByPinIdGeoData](../../models/operations/gettokenbypinidgeodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} | | `location` | [::PlexRubySDK::Operations::GetTokenByPinIdGeoData](../../models/operations/gettokenbypinidgeodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `expires_in` | *::Integer* | :heavy_check_mark: | The number of seconds this pin expires, by default 900 seconds | 876 | | `expires_in` | *::Integer* | :heavy_check_mark: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z | | `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expires_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z | | `expires_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `auth_token` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | | | `auth_token` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `new_registration` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | | | `new_registration` | *T.nilable(::Object)* | :heavy_minus_sign: | N/A | |

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

@@ -13,7 +13,7 @@ Geo location data
| `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam | | `city` | *::String* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true | | `european_union_member` | *T::Boolean* | :heavy_check_mark: | Indicates if the country is a member of the European Union. | true |
| `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas | | `time_zone` | *::String* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *::Integer* | :heavy_check_mark: | The postal code of the location. | 802 | | `postal_code` | *::String* | :heavy_check_mark: | The postal code of the location. | 802 |
| `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true | | `in_privacy_restricted_country` | *T::Boolean* | :heavy_check_mark: | Indicates if the country has privacy restrictions. | true |
| `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true | | `in_privacy_restricted_region` | *T::Boolean* | :heavy_check_mark: | Indicates if the region has privacy restrictions. | true |
| `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas | | `subdivisions` | *::String* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |

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

@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | | | `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `x_plex_client_identifier` | *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_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 |

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

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *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_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 |
| `request_body` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | | `request_body` | [T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |

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

@@ -27,7 +27,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -62,7 +66,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -24,7 +24,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -68,7 +72,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -109,7 +117,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -150,11 +162,15 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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", login: "username@email.com",
password: "password123", password: "password123",
verification_code: "123456", verification_code: "123456",
@@ -170,7 +186,7 @@ end
| Parameter | Type | Required | Description | Example | | 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 | | | `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 | | `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( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -64,7 +68,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -100,7 +108,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -140,7 +152,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -182,7 +198,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -21,7 +21,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -64,7 +68,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -31,7 +31,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -74,7 +78,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -122,7 +130,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -196,7 +208,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -238,7 +254,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -299,7 +319,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -351,7 +375,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -411,7 +439,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -454,7 +486,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -496,7 +532,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -539,7 +579,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -582,7 +626,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -23,7 +23,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -87,7 +91,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -133,7 +141,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -24,7 +24,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -65,7 +69,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -107,7 +115,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -150,7 +162,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -200,7 +216,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -34,7 +34,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -82,7 +86,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -126,7 +134,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -168,7 +180,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -210,7 +226,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -257,7 +277,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -300,7 +324,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -343,7 +371,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -387,7 +419,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -26,7 +26,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -67,7 +71,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -108,7 +116,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -179,7 +195,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::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? if ! res.plex_devices.nil?
# handle response # handle response
@@ -200,7 +220,7 @@ end
| Parameter | Type | Required | Description | Example | | 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_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_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 | | `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 ## 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 ### Example Usage
@@ -224,11 +244,17 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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? if ! res.auth_pin_container.nil?
# handle response # handle response
@@ -238,12 +264,10 @@ end
### Parameters ### Parameters
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `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/> | | | `request` | [::PlexRubySDK::Operations::GetPinRequest](../../models/operations/getpinrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `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 | | `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. |
| `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 |
### Response ### Response
@@ -263,11 +287,15 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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? if ! res.auth_pin_container.nil?
# handle response # handle response
@@ -280,7 +308,7 @@ end
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *::Integer* | :heavy_check_mark: | The PinID to retrieve an access token for | | | `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 | | `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response ### Response

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

@@ -34,7 +34,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -81,7 +85,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -124,7 +132,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -28,7 +28,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -63,7 +67,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -98,7 +106,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -133,7 +145,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -168,7 +184,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -234,7 +258,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -285,7 +313,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -326,7 +358,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -23,7 +23,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -58,7 +62,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -102,7 +110,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -137,7 +149,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -22,7 +22,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -63,7 +67,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -104,7 +112,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -23,7 +23,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -58,7 +62,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -100,7 +108,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -21,7 +21,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(
@@ -75,7 +79,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

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

@@ -20,7 +20,11 @@ require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new( 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( s.config_security(
::PlexRubySDK::Shared::Security.new( ::PlexRubySDK::Shared::Security.new(

6
lib/plex_ruby_sdk/authentication.rb
View File

@@ -162,13 +162,13 @@ module PlexRubySDK
end end
sig { params(x_plex_client_identifier: T.nilable(::String), request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::PostUsersSignInDataResponse) } sig { params(client_id: T.nilable(::String), request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::PostUsersSignInDataResponse) }
def post_users_sign_in_data(x_plex_client_identifier = nil, request_body = nil, server_url = nil) def post_users_sign_in_data(client_id = nil, request_body = nil, server_url = nil)
# post_users_sign_in_data - Get User Sign In Data # post_users_sign_in_data - Get User Sign In Data
# Sign in user with username and password and return user data with Plex authentication token # Sign in user with username and password and return user data with Plex authentication token
request = ::PlexRubySDK::Operations::PostUsersSignInDataRequest.new( request = ::PlexRubySDK::Operations::PostUsersSignInDataRequest.new(
x_plex_client_identifier: x_plex_client_identifier, client_id: client_id,
request_body: request_body request_body: request_body
) )
base_url = Utils.template_url(POST_USERS_SIGN_IN_DATA_SERVERS[0], { base_url = Utils.template_url(POST_USERS_SIGN_IN_DATA_SERVERS[0], {

4
lib/plex_ruby_sdk/models/operations/geodata.rb
View File

@@ -31,14 +31,14 @@ module PlexRubySDK
# Indicates if the region has privacy restrictions. # Indicates if the region has privacy restrictions.
field :in_privacy_restricted_region, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('in_privacy_restricted_region') } } field :in_privacy_restricted_region, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('in_privacy_restricted_region') } }
# The postal code of the location. # The postal code of the location.
field :postal_code, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } } field :postal_code, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } }
# The name of the primary administrative subdivision. # The name of the primary administrative subdivision.
field :subdivisions, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subdivisions') } } field :subdivisions, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subdivisions') } }
# The time zone of the country. # The time zone of the country.
field :time_zone, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('time_zone') } } field :time_zone, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('time_zone') } }
sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::Integer, subdivisions: ::String, time_zone: ::String).void } sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::String, subdivisions: ::String, time_zone: ::String).void }
def initialize(city: nil, code: nil, continent_code: nil, coordinates: nil, country: nil, european_union_member: nil, in_privacy_restricted_country: nil, in_privacy_restricted_region: nil, postal_code: nil, subdivisions: nil, time_zone: nil) def initialize(city: nil, code: nil, continent_code: nil, coordinates: nil, country: nil, european_union_member: nil, in_privacy_restricted_country: nil, in_privacy_restricted_region: nil, postal_code: nil, subdivisions: nil, time_zone: nil)
@city = city @city = city
@code = code @code = code

16
lib/plex_ruby_sdk/models/operations/get_server_resources_request.rb
View File

@@ -14,6 +14,11 @@ module PlexRubySDK
class GetServerResourcesRequest < ::PlexRubySDK::Utils::FieldAugmented class GetServerResourcesRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig extend T::Sig
# The unique identifier for the client application
# This is used to track the client application and its usage
# (UUID, serial number, or other number unique per device)
#
field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
# Include Https entries in the results # Include Https entries in the results
field :include_https, T.nilable(::PlexRubySDK::Operations::IncludeHttps), { 'query_param': { 'field_name': 'includeHttps', 'style': 'form', 'explode': true } } field :include_https, T.nilable(::PlexRubySDK::Operations::IncludeHttps), { 'query_param': { 'field_name': 'includeHttps', 'style': 'form', 'explode': true } }
# Include IPv6 entries in the results # Include IPv6 entries in the results
@@ -22,19 +27,14 @@ module PlexRubySDK
# E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400 # E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
# #
field :include_relay, T.nilable(::PlexRubySDK::Operations::IncludeRelay), { 'query_param': { 'field_name': 'includeRelay', 'style': 'form', 'explode': true } } field :include_relay, T.nilable(::PlexRubySDK::Operations::IncludeRelay), { 'query_param': { 'field_name': 'includeRelay', 'style': 'form', 'explode': true } }
# The unique identifier for the client application
# This is used to track the client application and its usage
# (UUID, serial number, or other number unique per device)
#
field :x_plex_client_identifier, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
sig { params(include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay), x_plex_client_identifier: T.nilable(::String)).void } sig { params(client_id: T.nilable(::String), include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay)).void }
def initialize(include_https: nil, include_i_pv6: nil, include_relay: nil, x_plex_client_identifier: nil) def initialize(client_id: nil, include_https: nil, include_i_pv6: nil, include_relay: nil)
@client_id = client_id
@include_https = include_https @include_https = include_https
@include_i_pv6 = include_i_pv6 @include_i_pv6 = include_i_pv6
@include_relay = include_relay @include_relay = include_relay
@x_plex_client_identifier = x_plex_client_identifier
end end
end end
end end

4
lib/plex_ruby_sdk/models/operations/getgeodata_geodata.rb
View File

@@ -31,14 +31,14 @@ module PlexRubySDK
# Indicates if the region has privacy restrictions. # Indicates if the region has privacy restrictions.
field :in_privacy_restricted_region, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('in_privacy_restricted_region') } } field :in_privacy_restricted_region, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('in_privacy_restricted_region') } }
# The postal code of the location. # The postal code of the location.
field :postal_code, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } } field :postal_code, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } }
# The name of the primary administrative subdivision. # The name of the primary administrative subdivision.
field :subdivisions, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subdivisions') } } field :subdivisions, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subdivisions') } }
# The time zone of the country. # The time zone of the country.
field :time_zone, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('time_zone') } } field :time_zone, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('time_zone') } }
sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::Integer, subdivisions: ::String, time_zone: ::String).void } sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::String, subdivisions: ::String, time_zone: ::String).void }
def initialize(city: nil, code: nil, continent_code: nil, coordinates: nil, country: nil, european_union_member: nil, in_privacy_restricted_country: nil, in_privacy_restricted_region: nil, postal_code: nil, subdivisions: nil, time_zone: nil) def initialize(city: nil, code: nil, continent_code: nil, coordinates: nil, country: nil, european_union_member: nil, in_privacy_restricted_country: nil, in_privacy_restricted_region: nil, postal_code: nil, subdivisions: nil, time_zone: nil)
@city = city @city = city
@code = code @code = code

4
lib/plex_ruby_sdk/models/operations/getpin_authpincontainer.rb
View File

@@ -35,12 +35,12 @@ module PlexRubySDK
field :trusted, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('trusted') } } field :trusted, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('trusted') } }
field :auth_token, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('authToken') } } field :auth_token, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('authToken') } }
field :new_registration, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('newRegistration') } } field :new_registration, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('newRegistration') } }
sig { params(client_identifier: ::String, code: ::String, created_at: ::DateTime, expires_at: ::DateTime, expires_in: ::Integer, id: ::Integer, location: ::PlexRubySDK::Operations::GeoData, product: ::String, qr: ::String, trusted: T::Boolean, auth_token: T.nilable(::Object), new_registration: T.nilable(::Object)).void } sig { params(client_identifier: ::String, code: ::String, created_at: ::DateTime, expires_at: ::DateTime, expires_in: ::Integer, id: ::Integer, location: ::PlexRubySDK::Operations::GeoData, product: ::String, qr: ::String, trusted: T::Boolean, auth_token: T.nilable(::String), new_registration: T.nilable(::Object)).void }
def initialize(client_identifier: nil, code: nil, created_at: nil, expires_at: nil, expires_in: nil, id: nil, location: nil, product: nil, qr: nil, trusted: nil, auth_token: nil, new_registration: nil) def initialize(client_identifier: nil, code: nil, created_at: nil, expires_at: nil, expires_in: nil, id: nil, location: nil, product: nil, qr: nil, trusted: nil, auth_token: nil, new_registration: nil)
@client_identifier = client_identifier @client_identifier = client_identifier
@code = code @code = code

31
lib/plex_ruby_sdk/models/operations/getpin_request.rb
View File

@@ -14,25 +14,34 @@ module PlexRubySDK
class GetPinRequest < ::PlexRubySDK::Utils::FieldAugmented class GetPinRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig extend T::Sig
# The unique identifier for the client application
# This is used to track the client application and its usage
# (UUID, serial number, or other number unique per device)
#
field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
field :client_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } }
field :client_platform, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Platform', 'style': 'form', 'explode': true } }
field :client_version, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Version', 'style': 'form', 'explode': true } }
field :device_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Device', 'style': 'form', 'explode': true } }
# Determines the kind of code returned by the API call # Determines the kind of code returned by the API call
# Strong codes are used for Pin authentication flows # Strong codes are used for Pin authentication flows
# Non-Strong codes are used for `Plex.tv/link` # Non-Strong codes are used for `Plex.tv/link`
# #
field :strong, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'strong', 'style': 'form', 'explode': true } } field :strong, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'strong', 'style': 'form', 'explode': true } }
# The unique identifier for the client application
# This is used to track the client application and its usage
# (UUID, serial number, or other number unique per device)
#
field :x_plex_client_identifier, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
field :x_plex_product, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } }
sig { params(strong: T.nilable(T::Boolean), x_plex_client_identifier: T.nilable(::String), x_plex_product: T.nilable(::String)).void } sig { params(client_id: T.nilable(::String), client_name: T.nilable(::String), client_platform: T.nilable(::String), client_version: T.nilable(::String), device_name: T.nilable(::String), strong: T.nilable(T::Boolean)).void }
def initialize(strong: nil, x_plex_client_identifier: nil, x_plex_product: nil) def initialize(client_id: nil, client_name: nil, client_platform: nil, client_version: nil, device_name: nil, strong: nil)
@client_id = client_id
@client_name = client_name
@client_platform = client_platform
@client_version = client_version
@device_name = device_name
@strong = strong @strong = strong
@x_plex_client_identifier = x_plex_client_identifier
@x_plex_product = x_plex_product
end end
end end
end end

4
lib/plex_ruby_sdk/models/operations/gettokenbypinid_authpincontainer.rb
View File

@@ -35,12 +35,12 @@ module PlexRubySDK
field :trusted, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('trusted') } } field :trusted, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('trusted') } }
field :auth_token, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('authToken') } } field :auth_token, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('authToken') } }
field :new_registration, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('newRegistration') } } field :new_registration, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('newRegistration') } }
sig { params(client_identifier: ::String, code: ::String, created_at: ::DateTime, expires_at: ::DateTime, expires_in: ::Integer, id: ::Integer, location: ::PlexRubySDK::Operations::GetTokenByPinIdGeoData, product: ::String, qr: ::String, trusted: T::Boolean, auth_token: T.nilable(::Object), new_registration: T.nilable(::Object)).void } sig { params(client_identifier: ::String, code: ::String, created_at: ::DateTime, expires_at: ::DateTime, expires_in: ::Integer, id: ::Integer, location: ::PlexRubySDK::Operations::GetTokenByPinIdGeoData, product: ::String, qr: ::String, trusted: T::Boolean, auth_token: T.nilable(::String), new_registration: T.nilable(::Object)).void }
def initialize(client_identifier: nil, code: nil, created_at: nil, expires_at: nil, expires_in: nil, id: nil, location: nil, product: nil, qr: nil, trusted: nil, auth_token: nil, new_registration: nil) def initialize(client_identifier: nil, code: nil, created_at: nil, expires_at: nil, expires_in: nil, id: nil, location: nil, product: nil, qr: nil, trusted: nil, auth_token: nil, new_registration: nil)
@client_identifier = client_identifier @client_identifier = client_identifier
@code = code @code = code

4
lib/plex_ruby_sdk/models/operations/gettokenbypinid_geodata.rb
View File

@@ -31,14 +31,14 @@ module PlexRubySDK
# Indicates if the region has privacy restrictions. # Indicates if the region has privacy restrictions.
field :in_privacy_restricted_region, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('in_privacy_restricted_region') } } field :in_privacy_restricted_region, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('in_privacy_restricted_region') } }
# The postal code of the location. # The postal code of the location.
field :postal_code, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } } field :postal_code, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } }
# The name of the primary administrative subdivision. # The name of the primary administrative subdivision.
field :subdivisions, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subdivisions') } } field :subdivisions, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subdivisions') } }
# The time zone of the country. # The time zone of the country.
field :time_zone, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('time_zone') } } field :time_zone, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('time_zone') } }
sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::Integer, subdivisions: ::String, time_zone: ::String).void } sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::String, subdivisions: ::String, time_zone: ::String).void }
def initialize(city: nil, code: nil, continent_code: nil, coordinates: nil, country: nil, european_union_member: nil, in_privacy_restricted_country: nil, in_privacy_restricted_region: nil, postal_code: nil, subdivisions: nil, time_zone: nil) def initialize(city: nil, code: nil, continent_code: nil, coordinates: nil, country: nil, european_union_member: nil, in_privacy_restricted_country: nil, in_privacy_restricted_region: nil, postal_code: nil, subdivisions: nil, time_zone: nil)
@city = city @city = city
@code = code @code = code

8
lib/plex_ruby_sdk/models/operations/gettokenbypinid_request.rb
View File

@@ -20,13 +20,13 @@ module PlexRubySDK
# This is used to track the client application and its usage # This is used to track the client application and its usage
# (UUID, serial number, or other number unique per device) # (UUID, serial number, or other number unique per device)
# #
field :x_plex_client_identifier, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } } field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
sig { params(pin_id: ::Integer, x_plex_client_identifier: T.nilable(::String)).void } sig { params(pin_id: ::Integer, client_id: T.nilable(::String)).void }
def initialize(pin_id: nil, x_plex_client_identifier: nil) def initialize(pin_id: nil, client_id: nil)
@pin_id = pin_id @pin_id = pin_id
@x_plex_client_identifier = x_plex_client_identifier @client_id = client_id
end end
end end
end end

12
lib/plex_ruby_sdk/models/operations/post_users_sign_in_data_request.rb
View File

@@ -14,19 +14,19 @@ module PlexRubySDK
class PostUsersSignInDataRequest < ::PlexRubySDK::Utils::FieldAugmented class PostUsersSignInDataRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig extend T::Sig
# Login credentials
field :request_body, T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), { 'request': { 'media_type': 'application/x-www-form-urlencoded' } }
# The unique identifier for the client application # The unique identifier for the client application
# This is used to track the client application and its usage # This is used to track the client application and its usage
# (UUID, serial number, or other number unique per device) # (UUID, serial number, or other number unique per device)
# #
field :x_plex_client_identifier, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } } field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
# Login credentials
field :request_body, T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), { 'request': { 'media_type': 'application/x-www-form-urlencoded' } }
sig { params(request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), x_plex_client_identifier: T.nilable(::String)).void } sig { params(client_id: T.nilable(::String), request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)).void }
def initialize(request_body: nil, x_plex_client_identifier: nil) def initialize(client_id: nil, request_body: nil)
@client_id = client_id
@request_body = request_body @request_body = request_body
@x_plex_client_identifier = x_plex_client_identifier
end end
end end
end end

26
lib/plex_ruby_sdk/plex.rb
View File

@@ -216,13 +216,13 @@ module PlexRubySDK
end end
sig { params(x_plex_client_identifier: T.nilable(::String), include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetServerResourcesResponse) } sig { params(client_id: T.nilable(::String), include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetServerResourcesResponse) }
def get_server_resources(x_plex_client_identifier = nil, include_https = nil, include_relay = nil, include_i_pv6 = nil, server_url = nil) def get_server_resources(client_id = nil, include_https = nil, include_relay = nil, include_i_pv6 = nil, server_url = nil)
# get_server_resources - Get Server Resources # get_server_resources - Get Server Resources
# Get Plex server access tokens and server connections # Get Plex server access tokens and server connections
request = ::PlexRubySDK::Operations::GetServerResourcesRequest.new( request = ::PlexRubySDK::Operations::GetServerResourcesRequest.new(
x_plex_client_identifier: x_plex_client_identifier, client_id: client_id,
include_https: include_https, include_https: include_https,
include_relay: include_relay, include_relay: include_relay,
include_i_pv6: include_i_pv6 include_i_pv6: include_i_pv6
@@ -267,16 +267,10 @@ module PlexRubySDK
end end
sig { params(strong: T.nilable(T::Boolean), x_plex_client_identifier: T.nilable(::String), x_plex_product: T.nilable(::String), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetPinResponse) } sig { params(request: T.nilable(::PlexRubySDK::Operations::GetPinRequest), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetPinResponse) }
def get_pin(strong = nil, x_plex_client_identifier = nil, x_plex_product = nil, server_url = nil) def get_pin(request, server_url = nil)
# get_pin - Get a Pin # get_pin - Get a Pin
# Retrieve a Pin from Plex.tv for authentication flows # Retrieve a Pin ID from Plex.tv to use for authentication flows
request = ::PlexRubySDK::Operations::GetPinRequest.new(
strong: strong,
x_plex_client_identifier: x_plex_client_identifier,
x_plex_product: x_plex_product
)
base_url = Utils.template_url(GET_PIN_SERVERS[0], { base_url = Utils.template_url(GET_PIN_SERVERS[0], {
}) })
base_url = server_url if !server_url.nil? base_url = server_url if !server_url.nil?
@@ -296,7 +290,7 @@ module PlexRubySDK
res = ::PlexRubySDK::Operations::GetPinResponse.new( res = ::PlexRubySDK::Operations::GetPinResponse.new(
status_code: r.status, content_type: content_type, raw_response: r status_code: r.status, content_type: content_type, raw_response: r
) )
if r.status == 200 if r.status == 201
if Utils.match_content_type(content_type, 'application/json') if Utils.match_content_type(content_type, 'application/json')
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetPinAuthPinContainer) out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetPinAuthPinContainer)
res.auth_pin_container = out res.auth_pin_container = out
@@ -311,14 +305,14 @@ module PlexRubySDK
end end
sig { params(pin_id: ::Integer, x_plex_client_identifier: T.nilable(::String), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetTokenByPinIdResponse) } sig { params(pin_id: ::Integer, client_id: T.nilable(::String), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetTokenByPinIdResponse) }
def get_token_by_pin_id(pin_id, x_plex_client_identifier = nil, server_url = nil) def get_token_by_pin_id(pin_id, client_id = nil, server_url = nil)
# get_token_by_pin_id - Get Access Token by PinId # get_token_by_pin_id - Get Access Token by PinId
# Retrieve an Access Token from Plex.tv after the Pin has been authenticated # Retrieve an Access Token from Plex.tv after the Pin has been authenticated
request = ::PlexRubySDK::Operations::GetTokenByPinIdRequest.new( request = ::PlexRubySDK::Operations::GetTokenByPinIdRequest.new(
pin_id: pin_id, pin_id: pin_id,
x_plex_client_identifier: x_plex_client_identifier client_id: client_id
) )
base_url = Utils.template_url(GET_TOKEN_BY_PIN_ID_SERVERS[0], { base_url = Utils.template_url(GET_TOKEN_BY_PIN_ID_SERVERS[0], {
}) })

24
lib/plex_ruby_sdk/plex_api.rb
View File

@@ -18,7 +18,11 @@ module PlexRubySDK
sig do sig do
params(client: Faraday::Request, params(client: Faraday::Request,
security: T.nilable(Shared::Security), security: T.nilable(Shared::Security),
x_plex_client_identifier: ::String, client_id: ::String,
client_name: ::String,
client_version: ::String,
client_platform: ::String,
device_name: ::String,
protocol: T.nilable(::PlexRubySDK::ServerVariables::ServerProtocol), protocol: T.nilable(::PlexRubySDK::ServerVariables::ServerProtocol),
ip: T.nilable(::String), ip: T.nilable(::String),
port: T.nilable(::String), port: T.nilable(::String),
@@ -28,7 +32,11 @@ module PlexRubySDK
end end
def initialize(client: nil, def initialize(client: nil,
security: nil, security: nil,
x_plex_client_identifier: nil, client_id: nil,
client_name: nil,
client_version: nil,
client_platform: nil,
device_name: nil,
protocol: nil, protocol: nil,
ip: nil, ip: nil,
port: nil, port: nil,
@@ -39,7 +47,11 @@ module PlexRubySDK
## Instantiates the SDK configuring it with the provided parameters. ## Instantiates the SDK configuring it with the provided parameters.
# @param [Faraday::Request] client The faraday HTTP client to use for all operations # @param [Faraday::Request] client The faraday HTTP client to use for all operations
# @param [Shared::Security] security The security details required for authentication # @param [Shared::Security] security The security details required for authentication
# @param [::String] x_plex_client_identifier: Configures the x_plex_client_identifier parameter for all supported operations # @param [::String] client_id: Configures the client_id parameter for all supported operations
# @param [::String] client_name: Configures the client_name parameter for all supported operations
# @param [::String] client_version: Configures the client_version parameter for all supported operations
# @param [::String] client_platform: Configures the client_platform parameter for all supported operations
# @param [::String] device_name: Configures the device_name parameter for all supported operations
# @param [T.nilable(::PlexRubySDK::ServerVariables::ServerProtocol)] protocol: Allows setting the protocol variable for url substitution # @param [T.nilable(::PlexRubySDK::ServerVariables::ServerProtocol)] protocol: Allows setting the protocol variable for url substitution
# @param [T.nilable(::String)] ip: Allows setting the ip variable for url substitution # @param [T.nilable(::String)] ip: Allows setting the ip variable for url substitution
# @param [T.nilable(::String)] port: Allows setting the port variable for url substitution # @param [T.nilable(::String)] port: Allows setting the port variable for url substitution
@@ -74,7 +86,11 @@ module PlexRubySDK
globals = { globals = {
'parameters': { 'parameters': {
'queryParam': { 'queryParam': {
'x_plex_client_identifier': x_plex_client_identifier, 'client_id': client_id,
'client_name': client_name,
'client_version': client_version,
'client_platform': client_platform,
'device_name': device_name,
}, },
'pathParam': { 'pathParam': {
}, },

6
lib/plex_ruby_sdk/sdkconfiguration.rb
View File

@@ -42,9 +42,9 @@ module PlexRubySDK
@globals = globals.nil? ? {} : globals @globals = globals.nil? ? {} : globals
@language = 'ruby' @language = 'ruby'
@openapi_doc_version = '0.0.3' @openapi_doc_version = '0.0.3'
@sdk_version = '0.3.5' @sdk_version = '0.3.6'
@gen_version = '2.415.8' @gen_version = '2.416.6'
@user_agent = 'speakeasy-sdk/ruby 0.3.5 2.415.8 0.0.3 plex_ruby_sdk' @user_agent = 'speakeasy-sdk/ruby 0.3.6 2.416.6 0.0.3 plex_ruby_sdk'
end end
sig { returns([String, T::Hash[Symbol, String]]) } sig { returns([String, T::Hash[Symbol, String]]) }

2
plex_ruby_sdk.gemspec
View File

@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
Gem::Specification.new do |s| Gem::Specification.new do |s|
s.name = 'plex_ruby_sdk' s.name = 'plex_ruby_sdk'
s.version = '0.3.5' s.version = '0.3.6'
s.platform = Gem::Platform::RUBY s.platform = Gem::Platform::RUBY
s.licenses = ['Apache-2.0'] s.licenses = ['Apache-2.0']
s.summary = '' s.summary = ''