module Crowdin::ApiResources::Translations

Public Instance Methods

apply_pre_translation(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 18
def apply_pre_translation(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}/pre-translations",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
build_project_directory_translation(directory_id = nil, query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 55
def build_project_directory_translation(directory_id = nil, query = {}, project_id = config.project_id)
  directory_id || raise_parameter_is_required_error(:directory_id)
  project_id   || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/translations/builds/directories/#{directory_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
build_project_file_translation(file_id = nil, query = {}, destination = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 68
def build_project_file_translation(file_id = nil, query = {}, destination = nil, project_id = config.project_id)
  file_id    || raise_parameter_is_required_error(:file_id)
  project_id || raise_project_id_is_required_error

  etag = query.delete(:eTag)
  headers = etag ? { 'If-None-Match' => etag } : {}

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/translations/builds/files/#{file_id}",
    { params: query, headers: headers }
  )
  Web::SendRequest.new(request, destination).perform
end
build_project_translation(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 96
def build_project_translation(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}/translations/builds",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
cancel_build(build_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 145
def cancel_build(build_id = nil, project_id = config.project_id)
  build_id   || raise_parameter_is_required_error(:build_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/translations/builds/#{build_id}"
  )
  Web::SendRequest.new(request).perform
end
check_project_build_status(build_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 133
def check_project_build_status(build_id = nil, project_id = config.project_id)
  build_id   || raise_parameter_is_required_error(:build_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/translations/builds/#{build_id}"
  )
  Web::SendRequest.new(request).perform
end
download_project_translations(build_id = nil, destination = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 121
def download_project_translations(build_id = nil, destination = nil, project_id = config.project_id)
  build_id    || raise_parameter_is_required_error(:build_id)
  project_id  || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/translations/builds/#{build_id}/download"
  )
  Web::SendRequest.new(request, destination).perform
end
edit_pre_translations(pre_translation_id = nil, query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 42
def edit_pre_translations(pre_translation_id = nil, query = {}, project_id = config.project_id)
  pre_translation_id || raise_parameter_is_required_error(:pre_translation_id)
  project_id         || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
export_project_translation(query = {}, destination = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 157
def export_project_translation(query = {}, destination = nil, 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}/translations/exports",
    { params: query }
  )
  Web::SendRequest.new(request, destination).perform
end
list_pre_translations(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 30
def list_pre_translations(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}/pre-translations",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_project_builds(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 84
def list_project_builds(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}/translations/builds",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
pre_translation_status(pre_translation_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 6
def pre_translation_status(pre_translation_id = nil, project_id = config.project_id)
  pre_translation_id || raise_parameter_is_required_error(:pre_translation_id)
  project_id         || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}"
  )
  Web::SendRequest.new(request).perform
end
upload_translations(language_id = nil, query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/translations.rb, line 108
def upload_translations(language_id = nil, query = {}, project_id = config.project_id)
  language_id || raise_parameter_is_required_error(:language_id)
  project_id  || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/translations/#{language_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end