plexruby/docs/sdks/plex

Plex

Overview

API Calls that perform operations directly against https://Plex.tv

Available Operations

• get_home_data - Get Plex Home Data
• get_pin - Get a Pin
• get_token - Get Access Token

get_home_data

Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status.

Example Usage

require 'plexruby'


s = ::OpenApiSDK::PlexAPI.new(
      x_plex_client_identifier: "Postman",
    )
s.config_security(
  ::OpenApiSDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.plex.get_home_data()

if ! res.two_hundred_application_json_object.nil?
  # handle response
end

Response

T.nilable(::OpenApiSDK::Operations::GetHomeDataResponse)

get_pin

Retrieve a Pin from Plex.tv for authentication flows

Example Usage

require 'plexruby'


s = ::OpenApiSDK::PlexAPI.new(
      x_plex_client_identifier: "Postman",
    )

    
res = s.plex.get_pin(x_plex_product="Postman", strong=false, x_plex_client_identifier="Postman")

if ! res.two_hundred_and_one_application_json_object.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
x_plex_product	::String	✔️	Product name of the application shown in the list of devices	Postman
strong	T::Boolean	➖	Determines the kind of code returned by the API call Strong codes are used for Pin authentication flows Non-Strong codes are used for Plex.tv/link
x_plex_client_identifier	::String	➖	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)	Postman
server_url	String	➖	An optional server URL to use.	http://localhost:8080

Response

T.nilable(::OpenApiSDK::Operations::GetPinResponse)

get_token

Retrieve an Access Token from Plex.tv after the Pin has already been authenticated

Example Usage

require 'plexruby'


s = ::OpenApiSDK::PlexAPI.new(
      x_plex_client_identifier: "Postman",
    )

    
res = s.plex.get_token(pin_id="<value>", x_plex_client_identifier="Postman")

if ! res.two_hundred_application_json_object.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
pin_id	::String	✔️	The PinID to retrieve an access token for
x_plex_client_identifier	::String	➖	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)	Postman
server_url	String	➖	An optional server URL to use.	http://localhost:8080

Response

T.nilable(::OpenApiSDK::Operations::GetTokenResponse)