Module: Crowdin::ApiResources::StringCorrections

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

Instance Method Summary collapse

Instance Method Details

#add_correction(body = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • body (Hash) (defaults to: {}) —

    Request Body



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/crowdin-api/api_resources/string_corrections.rb', line 25

def add_correction(body = {}, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  project_id || raise_project_id_is_required_error

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

#delete_correction(correction_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • correction_id (Integer) (defaults to: nil) —

    Correction Identifier



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/crowdin-api/api_resources/string_corrections.rb', line 72

def delete_correction(correction_id = nil, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  correction_id || raise_parameter_is_required_error(:correction_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/corrections/#{correction_id}"
  )
  Web::SendRequest.new(request).perform
end

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

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/crowdin-api/api_resources/string_corrections.rb', line 57

def delete_corrections(query = {}, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  project_id || raise_project_id_is_required_error

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

#get_correction(correction_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • correction_id (Integer) (defaults to: nil) —

    Correction Identifier

  • query (Hash) (defaults to: {}) —

    Request Query Parameters



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/crowdin-api/api_resources/string_corrections.rb', line 41

def get_correction(correction_id = nil, query = {}, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  correction_id || raise_parameter_is_required_error(:correction_id)
  project_id || raise_project_id_is_required_error

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

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

Parameters:

  • query (Hash) (defaults to: {}) —

    Request Query Parameters



10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/crowdin-api/api_resources/string_corrections.rb', line 10

def list_corrections(query = {}, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  project_id || raise_project_id_is_required_error

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

#restore_correction(correction_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • correction_id (Integer) (defaults to: nil) —

    Correction Identifier



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/crowdin-api/api_resources/string_corrections.rb', line 87

def restore_correction(correction_id = nil, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  correction_id || raise_parameter_is_required_error(:correction_id)
  project_id || raise_project_id_is_required_error

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