module Crowdin::ApiResources::Glossaries

Public Instance Methods

add_glossary(query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 16
def add_glossary(query = {})
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/glossaries",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
add_term(glossary_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 133
def add_term(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/glossaries/#{glossary_id}/terms",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
check_glossary_export_status(glossary_id = nil, export_id = nil) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 73
def check_glossary_export_status(glossary_id = nil, export_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  export_id   || raise_parameter_is_required_error(:export_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/exports/#{export_id}"
  )
  Web::SendRequest.new(request).perform
end
check_glossary_import_status(glossary_id = nil, import_id = nil) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 109
def check_glossary_import_status(glossary_id = nil, import_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  import_id   || raise_parameter_is_required_error(:import_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/imports/#{import_id}"
  )
  Web::SendRequest.new(request).perform
end
clear_glossary(glossary_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 145
def clear_glossary(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

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

  response.body.empty? ? response.code : JSON.parse(response.body)
rescue StandardError => e
  e.message
end
delete_concept(glossary_id = nil, concept_id = nil) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 235
def delete_concept(glossary_id = nil, concept_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  concept_id || raise_parameter_is_required_error(:concept_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}"
  )
  Web::SendRequest.new(request).perform
end
delete_glossary(glossary_id = nil) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 38
def delete_glossary(glossary_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/glossaries/#{glossary_id}"
  )
  Web::SendRequest.new(request).perform
end
delete_term(glossary_id = nil, term_id = nil) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 173
def delete_term(glossary_id = nil, term_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  term_id     || raise_parameter_is_required_error(:term_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}"
  )
  Web::SendRequest.new(request).perform
end
download_glossary(glossary_id = nil, export_id = nil, destination = nil) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 85
def download_glossary(glossary_id = nil, export_id = nil, destination = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  export_id   || raise_parameter_is_required_error(:export_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/exports/#{export_id}/download"
  )
  Web::SendRequest.new(request, destination).perform
end
edit_glossary(glossary_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 49
def edit_glossary(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/glossaries/#{glossary_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
edit_term(glossary_id = nil, term_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 185
def edit_term(glossary_id = nil, term_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  term_id     || raise_parameter_is_required_error(:term_id)

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
export_glossary(query = {}, glossary_id = nil, destination = nil) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 61
def export_glossary(query = {}, glossary_id = nil, destination = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/glossaries/#{glossary_id}/exports",
    { params: query }
  )
  Web::SendRequest.new(request, destination).perform
end
get_concept(glossary_id = nil, concept_id = nil) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 210
def get_concept(glossary_id = nil, concept_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  concept_id || raise_parameter_is_required_error(:concept_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}"
  )
  Web::SendRequest.new(request).perform
end
get_glossary(glossary_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 26
def get_glossary(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
get_term(glossary_id = nil, term_id = nil) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 161
def get_term(glossary_id = nil, term_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  term_id     || raise_parameter_is_required_error(:term_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}"
  )
  Web::SendRequest.new(request).perform
end
import_glossary(glossary_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 97
def import_glossary(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/glossaries/#{glossary_id}/imports",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_concepts(glossary_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 198
def list_concepts(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/concepts",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_glossaries(query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 6
def list_glossaries(query = {})
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_terms(glossary_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 121
def list_terms(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/terms",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
search_glossaries_concordance(project_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 247
def search_glossaries_concordance(project_id = nil, query = {})
  project_id || raise_project_id_is_required_error

  %i[source_language_id target_language_id expression].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}/glossaries/concordance",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
update_concept(glossary_id = nil, concept_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/glossaries.rb, line 222
def update_concept(glossary_id = nil, concept_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  concept_id || raise_parameter_is_required_error(:concept_id)

  request = Web::Request.new(
    connection,
    :put,
    "#{config.target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end