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.server.get_server_capabilities()

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

Response

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

get_server_preferences

Get Server Preferences

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.server.get_server_preferences()

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

Response

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

get_available_clients

Get Available Clients

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.server.get_available_clients()

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

Response

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

get_devices

Get Devices

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.server.get_devices()

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

Response

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

get_server_identity

Get Server Identity

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.server.get_server_identity()

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

Response

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

get_my_plex_account

Returns MyPlex Account Information

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.server.get_my_plex_account()

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

Response

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

get_resized_photo

Plex's Photo transcoder is used throughout the service to serve images at specified sizes.

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>",
  )
)


req = ::OpenApiSDK::Operations::GetResizedPhotoRequest.new(
  width: 110.0,
  height: 165.0,
  opacity: 643869,
  blur: 4000.0,
  min_size: ::OpenApiSDK::Operations::MinSize::ZERO,
  upscale: ::OpenApiSDK::Operations::Upscale::ZERO,
  url: "/library/metadata/49564/thumb/1654258204",
)
    
res = s.server.get_resized_photo(req)

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::OpenApiSDK::Operations::GetResizedPhotoRequest	✔️	The request object to use for the request.

Response

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

get_server_list

Get Server List

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.server.get_server_list()

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

Response

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