Module: Crowdin::ApiResources::Translations

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

Instance Method Summary collapse

Instance Method Details

#apply_pre_translation(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/translations.rb', line 24

def apply_pre_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}/pre-translations",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

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

Parameters:

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

    Request Body



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 233

def auto_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}/pre-translations",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#build_project_directory_translation(directory_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

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

    Directory Identifier

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

    Request Body



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

def build_project_directory_translation(directory_id = nil, query = {}, project_id = config.project_id)
  directory_id || raise_parameter_is_required_error(:directory_id)
  project_id   || raise_project_id_is_required_error

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

#build_project_file_translation(file_id = nil, query = {}, destination = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    File Identifier

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

    Request Body

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

    Destination of File



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 105

def build_project_file_translation(file_id = nil, query = {}, destination = nil, project_id = config.project_id)
  file_id    || raise_parameter_is_required_error(:file_id)
  project_id || raise_project_id_is_required_error

  etag = query.delete(:eTag)
  headers = etag ? { 'If-None-Match' => etag } : {}

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/translations/builds/files/#{file_id}",
    { params: query, headers: headers }
  )
  Web::SendRequest.new(request, destination).perform
end

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

Parameters:

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

    Request Body



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 139

def build_project_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/builds",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#cancel_build(build_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Project Build Identifier



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 202

def cancel_build(build_id = nil, project_id = config.project_id)
  build_id   || raise_parameter_is_required_error(:build_id)
  project_id || raise_project_id_is_required_error

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

#check_project_build_status(build_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Project Build Identifier



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 187

def check_project_build_status(build_id = nil, project_id = config.project_id)
  build_id   || raise_parameter_is_required_error(:build_id)
  project_id || raise_project_id_is_required_error

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

#download_project_translations(build_id = nil, destination = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Project Build Identifier

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

    Destination of File



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 172

def download_project_translations(build_id = nil, destination = nil, project_id = config.project_id)
  build_id    || raise_parameter_is_required_error(:build_id)
  project_id  || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/translations/builds/#{build_id}/download"
  )
  Web::SendRequest.new(request, destination).perform
end

#edit_pre_translations(pre_translation_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

  • pre_translation_id (Hash) (defaults to: nil) —

    Request Body

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

    Request Body



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

def edit_pre_translations(pre_translation_id = nil, query = {}, project_id = config.project_id)
  pre_translation_id || raise_parameter_is_required_error(:pre_translation_id)
  project_id         || raise_project_id_is_required_error

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

#export_project_translation(query = {}, destination = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Request Body

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

    Destination of File



218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 218

def export_project_translation(query = {}, destination = nil, 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/exports",
    { params: query }
  )
  Web::SendRequest.new(request, destination).perform
end

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

Parameters:

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

    Request Body



248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 248

def import_translations(body = {}, 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/imports",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#import_translations_report(import_translation_id, project_id = config.project_id) ⇒ Object

Parameters:

  • import_translation_id (String) —

    Import Translation Identifier



277
278
279
280
281
282
283
284
285
286
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 277

def import_translations_report(import_translation_id, 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/imports/#{import_translation_id}/report"
  )
  Web::SendRequest.new(request).perform
end

#import_translations_status(import_translation_id, project_id = config.project_id) ⇒ Object

Parameters:

  • import_translation_id (String) —

    Import Translation Identifier



263
264
265
266
267
268
269
270
271
272
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 263

def import_translations_status(import_translation_id, 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/imports/#{import_translation_id}"
  )
  Web::SendRequest.new(request).perform
end

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

Parameters:

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

    Request Query Parameters



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

def list_pre_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}/pre-translations",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

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

Parameters:

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

    Request Query Parameters



124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 124

def list_project_builds(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/builds",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#pre_translation_report(pre_translation_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • pre_translation_id (Hash) (defaults to: nil) —

    Request Body



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

def pre_translation_report(pre_translation_id = nil, project_id = config.project_id)
  pre_translation_id || raise_parameter_is_required_error(:pre_translation_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}/report"
  )
  Web::SendRequest.new(request).perform
end

#pre_translation_status(pre_translation_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

  • pre_translation_id (Hash) (defaults to: nil) —

    Request Body



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

def pre_translation_status(pre_translation_id = nil, project_id = config.project_id)
  pre_translation_id || raise_parameter_is_required_error(:pre_translation_id)
  project_id         || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}"
  )
  Web::SendRequest.new(request).perform
end

#upload_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 Body



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 155

def upload_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,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/translations/#{language_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

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

Parameters:

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

    Request Body



291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/crowdin-api/api_resources/translations.rb', line 291

def validate_text_by_qa_checks(body = [], 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/validate-qa-checks",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end