Module: Crowdin::ApiResources::StringTranslations

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

Instance Method Summary collapse

Instance Method Details

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

Parameters:

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

    Request Body



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

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) ⇒ Object

Parameters:

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

    Request Body



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 116

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 = {}) ⇒ Object

Parameters:

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

    Request Body



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 253

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) ⇒ Object

Parameters:

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

    Request Body



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 208

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

#approval_batch_operations(body = [], project_id = config.project_id) ⇒ Object

Parameters:

  • body (Array) (defaults to: []) —

    Request Body



272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 272

def approval_batch_operations(body = [], project_id = config.project_id)
  project_id || raise_project_id_is_required_error

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

#cancel_vote(vote_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Vote Identifier



238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 238

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) ⇒ Object

Parameters:

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

    Request Query Parameters



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 131

def delete_string_translations(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

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

#delete_translation(translation_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Translation Identifier



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 178

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) ⇒ Object

Parameters:

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

    Approval Identifier



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 39

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) ⇒ Object

Parameters:

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

    Translation Identifier

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

    Request Query Parameters



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 147

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) ⇒ Object

Parameters:

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

    Vote Identifier



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 223

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) ⇒ Object

Parameters:

  • language_id (String) (defaults to: nil) —

    Language Identifier

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

    Request Query Parameters



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 85

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) ⇒ Object

Parameters:

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

    Request Query Parameters



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 101

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) ⇒ Object

Parameters:

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

    Request Query Parameters



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

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) ⇒ Object

Parameters:

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

    Request Query Parameters



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 193

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) ⇒ Object

Parameters:

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

    Approval Identifier



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 54

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

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

Parameters:

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

    Request Query Parameters



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 69

def remove_string_approvals(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

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

#restore_translation(translation_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Translation Identifier



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 163

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

#search_translations(query = {}) ⇒ Object

Parameters:

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

    Request Query Parameters



302
303
304
305
306
307
308
309
310
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 302

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

#translation_batch_operations(body = [], project_id = config.project_id) ⇒ Object

Parameters:

  • body (Array) (defaults to: []) —

    Request Body



287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/crowdin-api/api_resources/string_translations.rb', line 287

def translation_batch_operations(body = [], project_id = config.project_id)
  project_id || raise_project_id_is_required_error

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