Class: Weblate::TranslationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/weblate/api/translations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TranslationsApi

Returns a new instance of TranslationsApi.



19
20
21
# File 'lib/weblate/api/translations_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/weblate/api/translations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#translations_autotranslate_create(component__project__slug, component__slug, language__code, translation, opts = {}) ⇒ Translation

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • translation (Translation)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



29
30
31
32
# File 'lib/weblate/api/translations_api.rb', line 29

def translations_autotranslate_create(component__project__slug, component__slug, language__code, translation, opts = {})
  data, _status_code, _headers = translations_autotranslate_create_with_http_info(component__project__slug, component__slug, language__code, translation, opts)
  data
end

#translations_autotranslate_create_with_http_info(component__project__slug, component__slug, language__code, translation, opts = {}) ⇒ Array<(Translation, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • translation (Translation)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Translation, Integer, Hash)>)

    Translation data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/weblate/api/translations_api.rb', line 41

def translations_autotranslate_create_with_http_info(component__project__slug, component__slug, language__code, translation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_autotranslate_create ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_autotranslate_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_autotranslate_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_autotranslate_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_autotranslate_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_autotranslate_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_autotranslate_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'translation' is set
  if @api_client.config.client_side_validation && translation.nil?
    fail ArgumentError, "Missing the required parameter 'translation' when calling TranslationsApi.translations_autotranslate_create"
  end
  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/autotranslate/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(translation)

  # return_type
  return_type = opts[:debug_return_type] || 'Translation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_autotranslate_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_autotranslate_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_changes_retrieve(component__project__slug, component__slug, language__code, opts = {}) ⇒ Translation

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



127
128
129
130
# File 'lib/weblate/api/translations_api.rb', line 127

def translations_changes_retrieve(component__project__slug, component__slug, language__code, opts = {})
  data, _status_code, _headers = translations_changes_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts)
  data
end

#translations_changes_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {}) ⇒ Array<(Translation, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Translation, Integer, Hash)>)

    Translation data, response status code and response headers



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/weblate/api/translations_api.rb', line 138

def translations_changes_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_changes_retrieve ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_changes_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_changes_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_changes_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_changes_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_changes_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_changes_retrieve, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/changes/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Translation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_changes_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_changes_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_destroy(component__project__slug, component__slug, language__code, opts = {}) ⇒ nil

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


215
216
217
218
# File 'lib/weblate/api/translations_api.rb', line 215

def translations_destroy(component__project__slug, component__slug, language__code, opts = {})
  translations_destroy_with_http_info(component__project__slug, component__slug, language__code, opts)
  nil
end

#translations_destroy_with_http_info(component__project__slug, component__slug, language__code, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>)

    nil, response status code and response headers



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/weblate/api/translations_api.rb', line 226

def translations_destroy_with_http_info(component__project__slug, component__slug, language__code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_destroy ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_destroy"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_destroy, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_destroy"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_destroy, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_destroy"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_destroy, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_destroy",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_file_create(component__project__slug, component__slug, language__code, file, opts = {}) ⇒ UploadRequest

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • file (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



307
308
309
310
# File 'lib/weblate/api/translations_api.rb', line 307

def translations_file_create(component__project__slug, component__slug, language__code, file, opts = {})
  data, _status_code, _headers = translations_file_create_with_http_info(component__project__slug, component__slug, language__code, file, opts)
  data
end

#translations_file_create_with_http_info(component__project__slug, component__slug, language__code, file, opts = {}) ⇒ Array<(UploadRequest, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • file (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(UploadRequest, Integer, Hash)>)

    UploadRequest data, response status code and response headers



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
# File 'lib/weblate/api/translations_api.rb', line 324

def translations_file_create_with_http_info(component__project__slug, component__slug, language__code, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_file_create ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_file_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_file_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_file_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_file_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_file_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_file_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling TranslationsApi.translations_file_create"
  end
  if @api_client.config.client_side_validation && !opts[:'author_name'].nil? && opts[:'author_name'].to_s.length > 200
    fail ArgumentError, 'invalid value for "opts[:"author_name"]" when calling TranslationsApi.translations_file_create, the character length must be smaller than or equal to 200.'
  end

  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/file/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = file
  form_params['author_email'] = opts[:'author_email'] if !opts[:'author_email'].nil?
  form_params['author_name'] = opts[:'author_name'] if !opts[:'author_name'].nil?
  form_params['method'] = opts[:'method'] if !opts[:'method'].nil?
  form_params['fuzzy'] = opts[:'fuzzy'] if !opts[:'fuzzy'].nil?
  form_params['conflicts'] = opts[:'conflicts'] if !opts[:'conflicts'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UploadRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_file_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_file_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_file_retrieve(component__project__slug, component__slug, language__code, opts = {}) ⇒ UploadRequest

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



420
421
422
423
# File 'lib/weblate/api/translations_api.rb', line 420

def translations_file_retrieve(component__project__slug, component__slug, language__code, opts = {})
  data, _status_code, _headers = translations_file_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts)
  data
end

#translations_file_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {}) ⇒ Array<(UploadRequest, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(UploadRequest, Integer, Hash)>)

    UploadRequest data, response status code and response headers



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'lib/weblate/api/translations_api.rb', line 431

def translations_file_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_file_retrieve ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_file_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_file_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_file_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_file_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_file_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_file_retrieve, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/file/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UploadRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_file_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_file_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_file_update(component__project__slug, component__slug, language__code, file, opts = {}) ⇒ UploadRequest

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • file (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



514
515
516
517
# File 'lib/weblate/api/translations_api.rb', line 514

def translations_file_update(component__project__slug, component__slug, language__code, file, opts = {})
  data, _status_code, _headers = translations_file_update_with_http_info(component__project__slug, component__slug, language__code, file, opts)
  data
end

#translations_file_update_with_http_info(component__project__slug, component__slug, language__code, file, opts = {}) ⇒ Array<(UploadRequest, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • file (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(UploadRequest, Integer, Hash)>)

    UploadRequest data, response status code and response headers



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
# File 'lib/weblate/api/translations_api.rb', line 531

def translations_file_update_with_http_info(component__project__slug, component__slug, language__code, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_file_update ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_file_update"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_file_update, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_file_update"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_file_update, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_file_update"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_file_update, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling TranslationsApi.translations_file_update"
  end
  if @api_client.config.client_side_validation && !opts[:'author_name'].nil? && opts[:'author_name'].to_s.length > 200
    fail ArgumentError, 'invalid value for "opts[:"author_name"]" when calling TranslationsApi.translations_file_update, the character length must be smaller than or equal to 200.'
  end

  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/file/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = file
  form_params['author_email'] = opts[:'author_email'] if !opts[:'author_email'].nil?
  form_params['author_name'] = opts[:'author_name'] if !opts[:'author_name'].nil?
  form_params['method'] = opts[:'method'] if !opts[:'method'].nil?
  form_params['fuzzy'] = opts[:'fuzzy'] if !opts[:'fuzzy'].nil?
  form_params['conflicts'] = opts[:'conflicts'] if !opts[:'conflicts'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UploadRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_file_update",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_file_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_list(opts = {}) ⇒ PaginatedTranslationList

Translation components API.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    A page number within the paginated result set.

  • :page_size (Integer)

    Number of results to return per page.

Returns:



626
627
628
629
# File 'lib/weblate/api/translations_api.rb', line 626

def translations_list(opts = {})
  data, _status_code, _headers = translations_list_with_http_info(opts)
  data
end

#translations_list_with_http_info(opts = {}) ⇒ Array<(PaginatedTranslationList, Integer, Hash)>

Translation components API.

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    A page number within the paginated result set.

  • :page_size (Integer)

    Number of results to return per page.

Returns:

  • (Array<(PaginatedTranslationList, Integer, Hash)>)

    PaginatedTranslationList data, response status code and response headers



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
# File 'lib/weblate/api/translations_api.rb', line 636

def translations_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_list ...'
  end
  # resource path
  local_var_path = '/translations/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedTranslationList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_repository_create(component__project__slug, component__slug, language__code, repo_request, opts = {}) ⇒ RepoRequest

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • repo_request (RepoRequest)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



689
690
691
692
# File 'lib/weblate/api/translations_api.rb', line 689

def translations_repository_create(component__project__slug, component__slug, language__code, repo_request, opts = {})
  data, _status_code, _headers = translations_repository_create_with_http_info(component__project__slug, component__slug, language__code, repo_request, opts)
  data
end

#translations_repository_create_with_http_info(component__project__slug, component__slug, language__code, repo_request, opts = {}) ⇒ Array<(RepoRequest, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • repo_request (RepoRequest)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(RepoRequest, Integer, Hash)>)

    RepoRequest data, response status code and response headers



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
# File 'lib/weblate/api/translations_api.rb', line 701

def translations_repository_create_with_http_info(component__project__slug, component__slug, language__code, repo_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_repository_create ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_repository_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_repository_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_repository_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_repository_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_repository_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_repository_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'repo_request' is set
  if @api_client.config.client_side_validation && repo_request.nil?
    fail ArgumentError, "Missing the required parameter 'repo_request' when calling TranslationsApi.translations_repository_create"
  end
  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/repository/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(repo_request)

  # return_type
  return_type = opts[:debug_return_type] || 'RepoRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_repository_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_repository_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_repository_retrieve(component__project__slug, component__slug, language__code, opts = {}) ⇒ RepoRequest

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



787
788
789
790
# File 'lib/weblate/api/translations_api.rb', line 787

def translations_repository_retrieve(component__project__slug, component__slug, language__code, opts = {})
  data, _status_code, _headers = translations_repository_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts)
  data
end

#translations_repository_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {}) ⇒ Array<(RepoRequest, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(RepoRequest, Integer, Hash)>)

    RepoRequest data, response status code and response headers



798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
# File 'lib/weblate/api/translations_api.rb', line 798

def translations_repository_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_repository_retrieve ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_repository_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_repository_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_repository_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_repository_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_repository_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_repository_retrieve, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/repository/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RepoRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_repository_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_repository_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_retrieve(component__project__slug, component__slug, language__code, opts = {}) ⇒ Translation

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



875
876
877
878
# File 'lib/weblate/api/translations_api.rb', line 875

def translations_retrieve(component__project__slug, component__slug, language__code, opts = {})
  data, _status_code, _headers = translations_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts)
  data
end

#translations_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {}) ⇒ Array<(Translation, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Translation, Integer, Hash)>)

    Translation data, response status code and response headers



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
# File 'lib/weblate/api/translations_api.rb', line 886

def translations_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_retrieve ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_retrieve, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Translation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_statistics_retrieve(component__project__slug, component__slug, language__code, opts = {}) ⇒ Translation

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



963
964
965
966
# File 'lib/weblate/api/translations_api.rb', line 963

def translations_statistics_retrieve(component__project__slug, component__slug, language__code, opts = {})
  data, _status_code, _headers = translations_statistics_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts)
  data
end

#translations_statistics_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {}) ⇒ Array<(Translation, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Translation, Integer, Hash)>)

    Translation data, response status code and response headers



974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
# File 'lib/weblate/api/translations_api.rb', line 974

def translations_statistics_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_statistics_retrieve ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_statistics_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_statistics_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_statistics_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_statistics_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_statistics_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_statistics_retrieve, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/statistics/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Translation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_statistics_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_statistics_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_units_create(component__project__slug, component__slug, language__code, translation, opts = {}) ⇒ Translation

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • translation (Translation)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1052
1053
1054
1055
# File 'lib/weblate/api/translations_api.rb', line 1052

def translations_units_create(component__project__slug, component__slug, language__code, translation, opts = {})
  data, _status_code, _headers = translations_units_create_with_http_info(component__project__slug, component__slug, language__code, translation, opts)
  data
end

#translations_units_create_with_http_info(component__project__slug, component__slug, language__code, translation, opts = {}) ⇒ Array<(Translation, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • translation (Translation)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Translation, Integer, Hash)>)

    Translation data, response status code and response headers



1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
# File 'lib/weblate/api/translations_api.rb', line 1064

def translations_units_create_with_http_info(component__project__slug, component__slug, language__code, translation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_units_create ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_units_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_units_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_units_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_units_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_units_create"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_units_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'translation' is set
  if @api_client.config.client_side_validation && translation.nil?
    fail ArgumentError, "Missing the required parameter 'translation' when calling TranslationsApi.translations_units_create"
  end
  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/units/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(translation)

  # return_type
  return_type = opts[:debug_return_type] || 'Translation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_units_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_units_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#translations_units_retrieve(component__project__slug, component__slug, language__code, opts = {}) ⇒ Translation

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1150
1151
1152
1153
# File 'lib/weblate/api/translations_api.rb', line 1150

def translations_units_retrieve(component__project__slug, component__slug, language__code, opts = {})
  data, _status_code, _headers = translations_units_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts)
  data
end

#translations_units_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {}) ⇒ Array<(Translation, Integer, Hash)>

Translation components API.

Parameters:

  • component__project__slug (String)
  • component__slug (String)
  • language__code (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Translation, Integer, Hash)>)

    Translation data, response status code and response headers



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
# File 'lib/weblate/api/translations_api.rb', line 1161

def translations_units_retrieve_with_http_info(component__project__slug, component__slug, language__code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_units_retrieve ...'
  end
  # verify the required parameter 'component__project__slug' is set
  if @api_client.config.client_side_validation && component__project__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__project__slug' when calling TranslationsApi.translations_units_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__project__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__project__slug' when calling TranslationsApi.translations_units_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'component__slug' is set
  if @api_client.config.client_side_validation && component__slug.nil?
    fail ArgumentError, "Missing the required parameter 'component__slug' when calling TranslationsApi.translations_units_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && component__slug !~ pattern
    fail ArgumentError, "invalid value for 'component__slug' when calling TranslationsApi.translations_units_retrieve, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'language__code' is set
  if @api_client.config.client_side_validation && language__code.nil?
    fail ArgumentError, "Missing the required parameter 'language__code' when calling TranslationsApi.translations_units_retrieve"
  end
  pattern = Regexp.new(/^[^\/]+$/)
  if @api_client.config.client_side_validation && language__code !~ pattern
    fail ArgumentError, "invalid value for 'language__code' when calling TranslationsApi.translations_units_retrieve, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/translations/{component__project__slug}/{component__slug}/{language__code}/units/'.sub('{' + 'component__project__slug' + '}', CGI.escape(component__project__slug.to_s)).sub('{' + 'component__slug' + '}', CGI.escape(component__slug.to_s)).sub('{' + 'language__code' + '}', CGI.escape(language__code.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Translation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"TranslationsApi.translations_units_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranslationsApi#translations_units_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end