module Crowdin::ApiResources::StringComments

Public Instance Methods

add_string_comment(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_comments.rb, line 18
def add_string_comment(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}/comments",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
delete_string_comment(string_comment_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_comments.rb, line 42
def delete_string_comment(string_comment_id = nil, project_id = config.project_id)
  string_comment_id || raise_parameter_is_required_error(:string_comment_id)
  project_id        || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/comments/#{string_comment_id}"
  )
  Web::SendRequest.new(request).perform
end
edit_string_comment(string_comment_id = nil, query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_comments.rb, line 54
def edit_string_comment(string_comment_id = nil, query = {}, project_id = config.project_id)
  string_comment_id || raise_parameter_is_required_error(:string_comment_id)
  project_id        || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/projects/#{project_id}/comments/#{string_comment_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
get_string_comment(string_comment_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_comments.rb, line 30
def get_string_comment(string_comment_id = nil, project_id = config.project_id)
  string_comment_id || raise_parameter_is_required_error(:string_comment_id)
  project_id        || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/comments/#{string_comment_id}"
  )
  Web::SendRequest.new(request).perform
end
list_string_comments(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/string_comments.rb, line 6
def list_string_comments(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}/comments",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end