module Crowdin::ApiResources::Reports
Public Instance Methods
add_report_settings_template(query = {}, project_id = config.project_id)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 131 def add_report_settings_template(query = {}, project_id = config.project_id) project_id || raise_project_id_is_required_error %i[name currency unit mode config].each do |param| query[param] || raise_parameter_is_required_error(param) end request = Web::Request.new( connection, :post, "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates", { params: query } ) Web::SendRequest.new(request).perform end
check_group_report_generation_status(group_id = nil, report_id = nil)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 57 def check_group_report_generation_status(group_id = nil, report_id = nil) enterprise_mode? || raise_only_for_enterprise_mode_error group_id || raise_parameter_is_required_error(:group_id) report_id || raise_parameter_is_required_error(:report_id) request = Web::Request.new( connection, :get, "#{config.target_api_url}/groups/#{group_id}/reports/#{report_id}" ) Web::SendRequest.new(request).perform end
check_organization_report_generation_status(report_id = nil)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 95 def check_organization_report_generation_status(report_id = nil) enterprise_mode? || raise_only_for_enterprise_mode_error report_id || raise_parameter_is_required_error(:report_id) request = Web::Request.new( connection, :get, "#{config.target_api_url}/reports/#{report_id}" ) Web::SendRequest.new(request).perform end
check_report_generation_status(report_id = nil, project_id = config.project_id)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 18 def check_report_generation_status(report_id = nil, project_id = config.project_id) report_id || raise_parameter_is_required_error(:report_id) project_id || raise_project_id_is_required_error request = Web::Request.new( connection, :get, "#{config.target_api_url}/projects/#{project_id}/reports/#{report_id}" ) Web::SendRequest.new(request).perform end
delete_report_settings_template(template_id = nil, project_id = config.project_id)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 171 def delete_report_settings_template(template_id = nil, project_id = config.project_id) project_id || raise_project_id_is_required_error template_id || raise_parameter_is_required_error(:template_id) request = Web::Request.new( connection, :delete, "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}" ) Web::SendRequest.new(request).perform end
download_group_report(group_id = nil, report_id = nil, destination = nil)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 70 def download_group_report(group_id = nil, report_id = nil, destination = nil) enterprise_mode? || raise_only_for_enterprise_mode_error group_id || raise_parameter_is_required_error(:group_id) report_id || raise_parameter_is_required_error(:report_id) request = Web::Request.new( connection, :get, "#{config.target_api_url}/groups/#{group_id}/reports/#{report_id}/download" ) Web::SendRequest.new(request, destination).perform end
download_organization_report(report_id = nil, destination = nil)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 107 def download_organization_report(report_id = nil, destination = nil) enterprise_mode? || raise_only_for_enterprise_mode_error report_id || raise_parameter_is_required_error(:report_id) request = Web::Request.new( connection, :get, "#{config.target_api_url}/reports/#{report_id}/download" ) Web::SendRequest.new(request, destination).perform end
download_report(report_id = nil, destination = nil, project_id = config.project_id)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 30 def download_report(report_id = nil, destination = nil, project_id = config.project_id) report_id || raise_parameter_is_required_error(:report_id) project_id || raise_project_id_is_required_error request = Web::Request.new( connection, :get, "#{config.target_api_url}/projects/#{project_id}/reports/#{report_id}/download" ) Web::SendRequest.new(request, destination).perform end
edit_report_settings_template(query = {}, template_id = nil, project_id = config.project_id)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 158 def edit_report_settings_template(query = {}, template_id = nil, project_id = config.project_id) project_id || raise_project_id_is_required_error template_id || raise_parameter_is_required_error(:template_id) request = Web::Request.new( connection, :patch, "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}", { params: query } ) Web::SendRequest.new(request).perform end
generate_group_report(group_id = nil, query = {})
click to toggle source
– For Enterprise mode only –
# File lib/crowdin-api/api_resources/reports.rb, line 44 def generate_group_report(group_id = nil, query = {}) enterprise_mode? || raise_only_for_enterprise_mode_error group_id || raise_parameter_is_required_error(:group_id) request = Web::Request.new( connection, :post, "#{config.target_api_url}/groups/#{group_id}/reports", { params: query } ) Web::SendRequest.new(request).perform end
generate_organization_report(query = {})
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 83 def generate_organization_report(query = {}) enterprise_mode? || raise_only_for_enterprise_mode_error request = Web::Request.new( connection, :post, "#{config.target_api_url}/reports", { params: query } ) Web::SendRequest.new(request).perform end
generate_report(query = {}, project_id = config.project_id)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 6 def generate_report(query = {}, project_id = config.project_id) project_id || raise_project_id_is_required_error request = Web::Request.new( connection, :post, "#{config.target_api_url}/projects/#{project_id}/reports", { params: query } ) Web::SendRequest.new(request).perform end
get_report_settings_template(template_id = nil, project_id = config.project_id)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 146 def get_report_settings_template(template_id = nil, project_id = config.project_id) project_id || raise_project_id_is_required_error template_id || raise_parameter_is_required_error(:template_id) request = Web::Request.new( connection, :get, "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}" ) Web::SendRequest.new(request).perform end
list_report_settings_templates(query = {}, project_id = config.project_id)
click to toggle source
# File lib/crowdin-api/api_resources/reports.rb, line 119 def list_report_settings_templates(query = {}, project_id = config.project_id) project_id || raise_project_id_is_required_error request = Web::Request.new( connection, :get, "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates", { params: query } ) Web::SendRequest.new(request).perform end