module Crowdin::ApiResources::StringTranslations

Public Instance Methods

add_approval(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 18
def add_approval(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}/approvals",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
add_translation(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 79
def add_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",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
add_translation_alignment(project_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 192
def add_translation_alignment(project_id = nil, query = {})
  project_id || raise_project_id_is_required_error

  %i[source_language_id target_language_id text].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}/translations/alignment",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
add_vote(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 156
def add_vote(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}/votes",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
cancel_vote(vote_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 180
def cancel_vote(vote_id = nil, project_id = config.project_id)
  vote_id    || raise_parameter_is_required_error(:vote_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/votes/#{vote_id}"
  )
  Web::SendRequest.new(request).perform
end
delete_string_translations(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 91
def delete_string_translations(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

  response = ::RestClient::Request.execute(
    {
      method: :delete,
      url: config.base_url + config.target_api_url + "/projects/#{project_id}/translations",
      payload: query.to_json
    }.merge(@options)
  )

  response.body.empty? ? response.code : JSON.parse(response.body)
rescue StandardError => e
  e.message
end
delete_translation(translation_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 132
def delete_translation(translation_id = nil, project_id = config.project_id)
  translation_id || raise_parameter_is_required_error(:translation_id)
  project_id     || raise_project_id_is_required_error

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

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/approvals/#{approval_id}"
  )
  Web::SendRequest.new(request).perform
end
get_translation(translation_id = nil, query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 107
def get_translation(translation_id = nil, query = {}, project_id = config.project_id)
  translation_id || raise_parameter_is_required_error(:translation_id)
  project_id     || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/translations/#{translation_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
get_vote(vote_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 168
def get_vote(vote_id = nil, project_id = config.project_id)
  vote_id    || raise_parameter_is_required_error(:vote_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/votes/#{vote_id}"
  )
  Web::SendRequest.new(request).perform
end
list_language_translations(language_id = nil, query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 54
def list_language_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,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/languages/#{language_id}/translations",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_string_translations(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 67
def list_string_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}/translations",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_translation_approvals(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 6
def list_translation_approvals(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}/approvals",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_translation_votes(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 144
def list_translation_votes(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}/votes",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
remove_approval(approval_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 42
def remove_approval(approval_id = nil, project_id = config.project_id)
  approval_id || raise_parameter_is_required_error(:approval_id)
  project_id  || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/approvals/#{approval_id}"
  )
  Web::SendRequest.new(request).perform
end
restore_translation(translation_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_translations.rb, line 120
def restore_translation(translation_id = nil, project_id = config.project_id)
  translation_id || raise_parameter_is_required_error(:translation_id)
  project_id     || raise_project_id_is_required_error

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