Files
plexruby/lib/plex_ruby_sdk/media.rb

677 lines
28 KiB
Ruby

# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
# typed: true
# frozen_string_literal: true
require 'faraday'
require 'faraday/multipart'
require 'faraday/retry'
require 'sorbet-runtime'
require_relative 'sdk_hooks/hooks'
require_relative 'utils/retries'
module PlexRubySDK
extend T::Sig
class Media
extend T::Sig
# API Calls interacting with Plex Media Server Media
#
sig { params(sdk_config: SDKConfiguration).void }
def initialize(sdk_config)
@sdk_configuration = sdk_config
end
sig { params(key: ::Float, timeout_ms: T.nilable(Integer)).returns(Models::Operations::MarkPlayedResponse) }
def mark_played(key, timeout_ms = nil)
# mark_played - Mark Media Played
# This will mark the provided media key as Played.
request = Models::Operations::MarkPlayedRequest.new(
key: key
)
url, params = @sdk_configuration.get_server_details
base_url = Utils.template_url(url, params)
url = "#{base_url}/:/scrobble"
headers = {}
query_params = Utils.get_query_params(Models::Operations::MarkPlayedRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
timeout ||= @sdk_configuration.timeout
connection = @sdk_configuration.client
hook_ctx = SDKHooks::HookContext.new(
base_url: base_url,
oauth2_scopes: [],
operation_id: 'markPlayed',
security_source: @sdk_configuration.security_source
)
error = T.let(nil, T.nilable(StandardError))
http_response = T.let(nil, T.nilable(Faraday::Response))
begin
http_response = connection.get(url) do |req|
req.headers.merge!(headers)
req.options.timeout = timeout unless timeout.nil?
req.params = query_params
Utils.configure_request_security(req, security)
@sdk_configuration.hooks.before_request(
hook_ctx: SDKHooks::BeforeRequestHookContext.new(
hook_ctx: hook_ctx
),
request: req
)
end
rescue StandardError => e
error = e
ensure
if http_response.nil? || Utils.error_status?(http_response.status)
http_response = @sdk_configuration.hooks.after_error(
error: error,
hook_ctx: SDKHooks::AfterErrorHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
else
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
end
if http_response.nil?
raise error if !error.nil?
raise 'no response'
end
end
content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
if Utils.match_status_code(http_response.status, ['200'])
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
return Models::Operations::MarkPlayedResponse.new(
status_code: http_response.status,
content_type: content_type,
raw_response: http_response
)
elsif Utils.match_status_code(http_response.status, ['400'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::MarkPlayedBadRequest)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['401'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::MarkPlayedUnauthorized)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['4XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
elsif Utils.match_status_code(http_response.status, ['5XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
end
end
sig { params(key: ::Float, timeout_ms: T.nilable(Integer)).returns(Models::Operations::MarkUnplayedResponse) }
def mark_unplayed(key, timeout_ms = nil)
# mark_unplayed - Mark Media Unplayed
# This will mark the provided media key as Unplayed.
request = Models::Operations::MarkUnplayedRequest.new(
key: key
)
url, params = @sdk_configuration.get_server_details
base_url = Utils.template_url(url, params)
url = "#{base_url}/:/unscrobble"
headers = {}
query_params = Utils.get_query_params(Models::Operations::MarkUnplayedRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
timeout ||= @sdk_configuration.timeout
connection = @sdk_configuration.client
hook_ctx = SDKHooks::HookContext.new(
base_url: base_url,
oauth2_scopes: [],
operation_id: 'markUnplayed',
security_source: @sdk_configuration.security_source
)
error = T.let(nil, T.nilable(StandardError))
http_response = T.let(nil, T.nilable(Faraday::Response))
begin
http_response = connection.get(url) do |req|
req.headers.merge!(headers)
req.options.timeout = timeout unless timeout.nil?
req.params = query_params
Utils.configure_request_security(req, security)
@sdk_configuration.hooks.before_request(
hook_ctx: SDKHooks::BeforeRequestHookContext.new(
hook_ctx: hook_ctx
),
request: req
)
end
rescue StandardError => e
error = e
ensure
if http_response.nil? || Utils.error_status?(http_response.status)
http_response = @sdk_configuration.hooks.after_error(
error: error,
hook_ctx: SDKHooks::AfterErrorHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
else
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
end
if http_response.nil?
raise error if !error.nil?
raise 'no response'
end
end
content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
if Utils.match_status_code(http_response.status, ['200'])
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
return Models::Operations::MarkUnplayedResponse.new(
status_code: http_response.status,
content_type: content_type,
raw_response: http_response
)
elsif Utils.match_status_code(http_response.status, ['400'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::MarkUnplayedBadRequest)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['401'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::MarkUnplayedUnauthorized)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['4XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
elsif Utils.match_status_code(http_response.status, ['5XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
end
end
sig { params(key: ::String, time: ::Float, state: ::String, timeout_ms: T.nilable(Integer)).returns(Models::Operations::UpdatePlayProgressResponse) }
def update_play_progress(key, time, state, timeout_ms = nil)
# update_play_progress - Update Media Play Progress
# This API command can be used to update the play progress of a media item.
#
request = Models::Operations::UpdatePlayProgressRequest.new(
key: key,
time: time,
state: state
)
url, params = @sdk_configuration.get_server_details
base_url = Utils.template_url(url, params)
url = "#{base_url}/:/progress"
headers = {}
query_params = Utils.get_query_params(Models::Operations::UpdatePlayProgressRequest, request)
headers['Accept'] = 'application/json'
headers['user-agent'] = @sdk_configuration.user_agent
security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
timeout ||= @sdk_configuration.timeout
connection = @sdk_configuration.client
hook_ctx = SDKHooks::HookContext.new(
base_url: base_url,
oauth2_scopes: [],
operation_id: 'updatePlayProgress',
security_source: @sdk_configuration.security_source
)
error = T.let(nil, T.nilable(StandardError))
http_response = T.let(nil, T.nilable(Faraday::Response))
begin
http_response = connection.post(url) do |req|
req.headers.merge!(headers)
req.options.timeout = timeout unless timeout.nil?
req.params = query_params
Utils.configure_request_security(req, security)
@sdk_configuration.hooks.before_request(
hook_ctx: SDKHooks::BeforeRequestHookContext.new(
hook_ctx: hook_ctx
),
request: req
)
end
rescue StandardError => e
error = e
ensure
if http_response.nil? || Utils.error_status?(http_response.status)
http_response = @sdk_configuration.hooks.after_error(
error: error,
hook_ctx: SDKHooks::AfterErrorHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
else
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
end
if http_response.nil?
raise error if !error.nil?
raise 'no response'
end
end
content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
if Utils.match_status_code(http_response.status, ['200'])
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
return Models::Operations::UpdatePlayProgressResponse.new(
status_code: http_response.status,
content_type: content_type,
raw_response: http_response
)
elsif Utils.match_status_code(http_response.status, ['400'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::UpdatePlayProgressBadRequest)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['401'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::UpdatePlayProgressUnauthorized)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['4XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
elsif Utils.match_status_code(http_response.status, ['5XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
end
end
sig { params(request: T.nilable(Models::Operations::GetBannerImageRequest), timeout_ms: T.nilable(Integer)).returns(Models::Operations::GetBannerImageResponse) }
def get_banner_image(request, timeout_ms = nil)
# get_banner_image - Get Banner Image
# Gets the banner image of the media item
url, params = @sdk_configuration.get_server_details
base_url = Utils.template_url(url, params)
url = Utils.generate_url(
Models::Operations::GetBannerImageRequest,
base_url,
'/library/metadata/{ratingKey}/banner',
request
)
headers = Utils.get_headers(request)
query_params = Utils.get_query_params(Models::Operations::GetBannerImageRequest, request)
headers['Accept'] = 'image/jpeg'
headers['user-agent'] = @sdk_configuration.user_agent
security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
timeout ||= @sdk_configuration.timeout
connection = @sdk_configuration.client
hook_ctx = SDKHooks::HookContext.new(
base_url: base_url,
oauth2_scopes: [],
operation_id: 'get-banner-image',
security_source: @sdk_configuration.security_source
)
error = T.let(nil, T.nilable(StandardError))
http_response = T.let(nil, T.nilable(Faraday::Response))
begin
http_response = connection.get(url) do |req|
req.headers.merge!(headers)
req.options.timeout = timeout unless timeout.nil?
req.params = query_params
Utils.configure_request_security(req, security)
@sdk_configuration.hooks.before_request(
hook_ctx: SDKHooks::BeforeRequestHookContext.new(
hook_ctx: hook_ctx
),
request: req
)
end
rescue StandardError => e
error = e
ensure
if http_response.nil? || Utils.error_status?(http_response.status)
http_response = @sdk_configuration.hooks.after_error(
error: error,
hook_ctx: SDKHooks::AfterErrorHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
else
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
end
if http_response.nil?
raise error if !error.nil?
raise 'no response'
end
end
content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
if Utils.match_status_code(http_response.status, ['200'])
if Utils.match_content_type(content_type, 'image/jpeg')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = http_response.env.body
return Models::Operations::GetBannerImageResponse.new(
status_code: http_response.status,
content_type: content_type,
raw_response: http_response,
headers: http_response.get_headers,
bytes: obj
)
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['400'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::GetBannerImageBadRequest)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['401'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::GetBannerImageUnauthorized)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['4XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
elsif Utils.match_status_code(http_response.status, ['5XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
end
end
sig { params(request: T.nilable(Models::Operations::GetThumbImageRequest), timeout_ms: T.nilable(Integer)).returns(Models::Operations::GetThumbImageResponse) }
def get_thumb_image(request, timeout_ms = nil)
# get_thumb_image - Get Thumb Image
# Gets the thumbnail image of the media item
url, params = @sdk_configuration.get_server_details
base_url = Utils.template_url(url, params)
url = Utils.generate_url(
Models::Operations::GetThumbImageRequest,
base_url,
'/library/metadata/{ratingKey}/thumb',
request
)
headers = Utils.get_headers(request)
query_params = Utils.get_query_params(Models::Operations::GetThumbImageRequest, request)
headers['Accept'] = 'image/jpeg'
headers['user-agent'] = @sdk_configuration.user_agent
security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
timeout ||= @sdk_configuration.timeout
connection = @sdk_configuration.client
hook_ctx = SDKHooks::HookContext.new(
base_url: base_url,
oauth2_scopes: [],
operation_id: 'get-thumb-image',
security_source: @sdk_configuration.security_source
)
error = T.let(nil, T.nilable(StandardError))
http_response = T.let(nil, T.nilable(Faraday::Response))
begin
http_response = connection.get(url) do |req|
req.headers.merge!(headers)
req.options.timeout = timeout unless timeout.nil?
req.params = query_params
Utils.configure_request_security(req, security)
@sdk_configuration.hooks.before_request(
hook_ctx: SDKHooks::BeforeRequestHookContext.new(
hook_ctx: hook_ctx
),
request: req
)
end
rescue StandardError => e
error = e
ensure
if http_response.nil? || Utils.error_status?(http_response.status)
http_response = @sdk_configuration.hooks.after_error(
error: error,
hook_ctx: SDKHooks::AfterErrorHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
else
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
end
if http_response.nil?
raise error if !error.nil?
raise 'no response'
end
end
content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
if Utils.match_status_code(http_response.status, ['200'])
if Utils.match_content_type(content_type, 'image/jpeg')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = http_response.env.body
return Models::Operations::GetThumbImageResponse.new(
status_code: http_response.status,
content_type: content_type,
raw_response: http_response,
headers: http_response.get_headers,
bytes: obj
)
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['400'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::GetThumbImageBadRequest)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['401'])
if Utils.match_content_type(content_type, 'application/json')
http_response = @sdk_configuration.hooks.after_success(
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
hook_ctx: hook_ctx
),
response: http_response
)
obj = Crystalline.unmarshal_json(JSON.parse(http_response.env.response_body), Models::Errors::GetThumbImageUnauthorized)
obj.raw_response = http_response
throw obj
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
end
elsif Utils.match_status_code(http_response.status, ['4XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
elsif Utils.match_status_code(http_response.status, ['5XX'])
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
else
raise ::PlexRubySDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
end
end
end
end