Module: Crowdin::ApiResources::StringComments

Defined in:
lib/crowdin-api/api_resources/string_comments.rb

Instance Method Summary collapse

Instance Method Details

#add_string_comment(query = {}, project_id = config.project_id) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
 
# 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) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
 
# 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) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
 
# 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) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
 
# 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) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
 
# 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