mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 12:47:44 +00:00
664 lines
28 KiB
Ruby
664 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 Butler
|
|
extend T::Sig
|
|
# Butler is the task manager of the Plex Media Server Ecosystem.
|
|
#
|
|
|
|
sig { params(sdk_config: SDKConfiguration).void }
|
|
def initialize(sdk_config)
|
|
@sdk_configuration = sdk_config
|
|
end
|
|
|
|
|
|
sig { params(timeout_ms: T.nilable(Integer)).returns(Models::Operations::GetButlerTasksResponse) }
|
|
def get_butler_tasks(timeout_ms = nil)
|
|
# get_butler_tasks - Get Butler tasks
|
|
# Returns a list of butler tasks
|
|
url, params = @sdk_configuration.get_server_details
|
|
base_url = Utils.template_url(url, params)
|
|
url = "#{base_url}/butler"
|
|
headers = {}
|
|
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: 'getButlerTasks',
|
|
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?
|
|
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, '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::Operations::GetButlerTasksResponseBody)
|
|
response = Models::Operations::GetButlerTasksResponse.new(
|
|
status_code: http_response.status,
|
|
content_type: content_type,
|
|
raw_response: http_response,
|
|
object: obj
|
|
)
|
|
|
|
return response
|
|
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::GetButlerTasksBadRequest)
|
|
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::GetButlerTasksUnauthorized)
|
|
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(timeout_ms: T.nilable(Integer)).returns(Models::Operations::StartAllTasksResponse) }
|
|
def start_all_tasks(timeout_ms = nil)
|
|
# start_all_tasks - Start all Butler tasks
|
|
# This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
|
# 1. Any tasks not scheduled to run on the current day will be skipped.
|
|
# 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
|
# 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
|
# 4. If we are outside the configured window, the task will start immediately.
|
|
#
|
|
url, params = @sdk_configuration.get_server_details
|
|
base_url = Utils.template_url(url, params)
|
|
url = "#{base_url}/butler"
|
|
headers = {}
|
|
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: 'startAllTasks',
|
|
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?
|
|
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::StartAllTasksResponse.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::StartAllTasksBadRequest)
|
|
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::StartAllTasksUnauthorized)
|
|
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(timeout_ms: T.nilable(Integer)).returns(Models::Operations::StopAllTasksResponse) }
|
|
def stop_all_tasks(timeout_ms = nil)
|
|
# stop_all_tasks - Stop all Butler tasks
|
|
# This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
|
#
|
|
url, params = @sdk_configuration.get_server_details
|
|
base_url = Utils.template_url(url, params)
|
|
url = "#{base_url}/butler"
|
|
headers = {}
|
|
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: 'stopAllTasks',
|
|
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.delete(url) do |req|
|
|
req.headers.merge!(headers)
|
|
req.options.timeout = timeout unless timeout.nil?
|
|
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::StopAllTasksResponse.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::StopAllTasksBadRequest)
|
|
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::StopAllTasksUnauthorized)
|
|
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(task_name: Models::Operations::TaskName, timeout_ms: T.nilable(Integer)).returns(Models::Operations::StartTaskResponse) }
|
|
def start_task(task_name, timeout_ms = nil)
|
|
# start_task - Start a single Butler task
|
|
# This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
|
|
# 1. Any tasks not scheduled to run on the current day will be skipped.
|
|
# 2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
|
|
# 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
|
|
# 4. If we are outside the configured window, the task will start immediately.
|
|
#
|
|
request = Models::Operations::StartTaskRequest.new(
|
|
|
|
task_name: task_name
|
|
)
|
|
url, params = @sdk_configuration.get_server_details
|
|
base_url = Utils.template_url(url, params)
|
|
url = Utils.generate_url(
|
|
Models::Operations::StartTaskRequest,
|
|
base_url,
|
|
'/butler/{taskName}',
|
|
request
|
|
)
|
|
headers = {}
|
|
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: 'startTask',
|
|
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?
|
|
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', '202'])
|
|
http_response = @sdk_configuration.hooks.after_success(
|
|
hook_ctx: SDKHooks::AfterSuccessHookContext.new(
|
|
hook_ctx: hook_ctx
|
|
),
|
|
response: http_response
|
|
)
|
|
return Models::Operations::StartTaskResponse.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::StartTaskBadRequest)
|
|
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::StartTaskUnauthorized)
|
|
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(task_name: Models::Operations::PathParamTaskName, timeout_ms: T.nilable(Integer)).returns(Models::Operations::StopTaskResponse) }
|
|
def stop_task(task_name, timeout_ms = nil)
|
|
# stop_task - Stop a single Butler task
|
|
# This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
|
|
#
|
|
request = Models::Operations::StopTaskRequest.new(
|
|
|
|
task_name: task_name
|
|
)
|
|
url, params = @sdk_configuration.get_server_details
|
|
base_url = Utils.template_url(url, params)
|
|
url = Utils.generate_url(
|
|
Models::Operations::StopTaskRequest,
|
|
base_url,
|
|
'/butler/{taskName}',
|
|
request
|
|
)
|
|
headers = {}
|
|
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: 'stopTask',
|
|
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.delete(url) do |req|
|
|
req.headers.merge!(headers)
|
|
req.options.timeout = timeout unless timeout.nil?
|
|
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::StopTaskResponse.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::StopTaskBadRequest)
|
|
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::StopTaskUnauthorized)
|
|
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, ['404', '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
|