Module: Crowdin::ApiResources::Reports

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

Instance Method Summary collapse

Instance Method Details

#add_organization_report_settings_template(body = {}) ⇒ Object

Parameters:

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

    Request Body



414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 414

def add_organization_report_settings_template(body = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/reports/settings-templates",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

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

Parameters:

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

    Request Body



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

def add_report_settings_template(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error
  %i[name currency unit mode config].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}/reports/settings-templates",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#add_user_report_settings_template(user_id, body = {}) ⇒ Object

Parameters:

  • user_id (Integer) —

    User Identifier

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

    Request Body



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

def add_user_report_settings_template(user_id, body = {})
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/users/#{user_id}/reports/settings-templates",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#check_group_report_generation_status(group_id = nil, report_id = nil) ⇒ Object

Parameters:

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

    Group Identifier

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

    Report Identifier, consists of 36 characters



325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 325

def check_group_report_generation_status(group_id = nil, report_id = nil)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  group_id         || raise_parameter_is_required_error(:group_id)
  report_id        || raise_parameter_is_required_error(:report_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/groups/#{group_id}/reports/#{report_id}"
  )
  Web::SendRequest.new(request).perform
end

#check_organization_report_generation_status(report_id = nil) ⇒ Object

Parameters:

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

    Report Identifier, consists of 36 characters



371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 371

def check_organization_report_generation_status(report_id = nil)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  report_id        || raise_parameter_is_required_error(:report_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/reports/#{report_id}"
  )
  Web::SendRequest.new(request).perform
end

#check_report_archive_export_status(archive_id, export_id, user_id = nil) ⇒ Object

Parameters:

  • archive_id (Integer) —

    Report archive identifier

  • export_id (String) —

    Export Identifier, consists of 36 characters

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

    User Identifier (Crowdin only)



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 128

def check_report_archive_export_status(archive_id, export_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "reports/archives/#{archive_id}/exports/#{export_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#check_report_generation_status(report_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Report Identifier, consists of 36 characters



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

def check_report_generation_status(report_id = nil, project_id = config.project_id)
  report_id  || raise_parameter_is_required_error(:report_id)
  project_id || raise_project_id_is_required_error

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

#delete_organization_report_settings_template(report_settings_template_id) ⇒ Object

Parameters:

  • report_settings_template_id (Integer) —

    Report Settings Template Identifier



428
429
430
431
432
433
434
435
436
437
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 428

def delete_organization_report_settings_template(report_settings_template_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/reports/settings-templates/#{report_settings_template_id}"
  )
  Web::SendRequest.new(request).perform
end

#delete_report_archive(archive_id, user_id = nil) ⇒ Object

Parameters:

  • archive_id (Integer) —

    Report archive identifier

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

    User Identifier (Crowdin only)



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 74

def delete_report_archive(archive_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "reports/archives/#{archive_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#delete_report_settings_template(template_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Request Body



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

def delete_report_settings_template(template_id = nil, project_id = config.project_id)
  project_id || raise_project_id_is_required_error
  template_id || raise_parameter_is_required_error(:template_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}"
  )
  Web::SendRequest.new(request).perform
end

#delete_user_report_settings_template(user_id, report_settings_template_id) ⇒ Object

Parameters:

  • user_id (Integer) —

    User Identifier

  • report_settings_template_id (Integer) —

    Report Settings Template Identifier



192
193
194
195
196
197
198
199
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 192

def delete_user_report_settings_template(user_id, report_settings_template_id)
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/users/#{user_id}/reports/settings-templates/#{report_settings_template_id}"
  )
  Web::SendRequest.new(request).perform
end

#download_group_report(group_id = nil, report_id = nil, destination = nil) ⇒ Object

Parameters:

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

    Group Identifier

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

    Report Identifier, consists of 36 characters

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

    Destination of File



342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 342

def download_group_report(group_id = nil, report_id = nil, destination = nil)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  group_id         || raise_parameter_is_required_error(:group_id)
  report_id        || raise_parameter_is_required_error(:report_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/groups/#{group_id}/reports/#{report_id}/download"
  )
  Web::SendRequest.new(request, destination).perform
end

#download_organization_report(report_id = nil, destination = nil) ⇒ Object

Parameters:

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

    Report Identifier, consists of 36 characters

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

    Destination of File



386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 386

def download_organization_report(report_id = nil, destination = nil)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  report_id        || raise_parameter_is_required_error(:report_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/reports/#{report_id}/download"
  )
  Web::SendRequest.new(request, destination).perform
end

#download_report(report_id = nil, destination = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Report Identifier, consists of 36 characters

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

    Destination of File



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

def download_report(report_id = nil, destination = nil, project_id = config.project_id)
  report_id  || raise_parameter_is_required_error(:report_id)
  project_id || raise_project_id_is_required_error

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

#download_report_archive(archive_id, export_id, destination = nil, user_id = nil) ⇒ Object

Parameters:

  • archive_id (Integer) —

    Report archive identifier

  • export_id (String) —

    Export Identifier, consists of 36 characters

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

    Destination of File

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

    User Identifier (Crowdin only)



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

def download_report_archive(archive_id, export_id, destination = nil, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "reports/archives/#{archive_id}/exports/#{export_id}/download"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request, destination).perform
end

#edit_organization_report_settings_template(report_settings_template_id, body = []) ⇒ Object

Parameters:

  • report_settings_template_id (Integer) —

    Report Settings Template Identifier

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

    Request Body



455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 455

def edit_organization_report_settings_template(report_settings_template_id, body = [])
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/reports/settings-templates/#{report_settings_template_id}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#edit_report_settings_template(query = {}, template_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Request Body

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

    Request Body



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

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

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#edit_user_report_settings_template(user_id, report_settings_template_id, body = []) ⇒ Object

Parameters:

  • user_id (Integer) —

    User Identifier

  • report_settings_template_id (Integer) —

    Report Settings Template Identifier

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

    Request Body



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

def edit_user_report_settings_template(user_id, report_settings_template_id, body = [])
  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/users/#{user_id}/reports/settings-templates/#{report_settings_template_id}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#export_report_archive(archive_id, body = {}, user_id = nil) ⇒ Object

Parameters:

  • archive_id (Integer) —

    Report archive identifier

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

    Request Body

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

    User Identifier (Crowdin only)



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 109

def export_report_archive(archive_id, body = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "reports/archives/#{archive_id}/exports"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/#{endpoint}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#generate_group_report(group_id = nil, query = {}) ⇒ Object

Parameters:

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

    Group Identifier

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

    Request Body



309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 309

def generate_group_report(group_id = nil, query = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error
  group_id         || raise_parameter_is_required_error(:group_id)

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/groups/#{group_id}/reports",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#generate_organization_report(query = {}) ⇒ Object

Parameters:

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

    Request Body



357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 357

def generate_organization_report(query = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/reports",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

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

Parameters:

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

    Request Body



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

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

#get_organization_report_settings_template(report_settings_template_id) ⇒ Object

Parameters:

  • report_settings_template_id (Integer) —

    Report Settings Template Identifier



441
442
443
444
445
446
447
448
449
450
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 441

def get_organization_report_settings_template(report_settings_template_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/reports/settings-templates/#{report_settings_template_id}"
  )
  Web::SendRequest.new(request).perform
end

#get_report_archive(archive_id, user_id = nil) ⇒ Object

Parameters:

  • archive_id (Integer) —

    Report archive identifier

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

    User Identifier (Crowdin only)



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 91

def get_report_archive(archive_id, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = "reports/archives/#{archive_id}"
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}"
  )
  Web::SendRequest.new(request).perform
end

#get_report_settings_template(template_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Request Body



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

def get_report_settings_template(template_id = nil, project_id = config.project_id)
  project_id || raise_project_id_is_required_error
  template_id || raise_parameter_is_required_error(:template_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}"
  )
  Web::SendRequest.new(request).perform
end

#get_user_report_settings_template(user_id, report_settings_template_id) ⇒ Object

Parameters:

  • user_id (Integer) —

    User Identifier

  • report_settings_template_id (Integer) —

    Report Settings Template Identifier



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

def get_user_report_settings_template(user_id, report_settings_template_id)
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/users/#{user_id}/reports/settings-templates/#{report_settings_template_id}"
  )
  Web::SendRequest.new(request).perform
end

#list_organization_report_settings_templates(query = {}) ⇒ Object

Parameters:

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

    Request Query Parameters



400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 400

def list_organization_report_settings_templates(query = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/reports/settings-templates",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#list_report_archives(query = {}, user_id = nil) ⇒ Object

Parameters:

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

    Request Query Parameters

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

    User Identifier (Crowdin only)



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

def list_report_archives(query = {}, user_id = nil)
  enterprise_mode? || user_id || raise_parameter_is_required_error(:user_id)

  endpoint = 'reports/archives'
  endpoint = "users/#{user_id}/#{endpoint}" unless enterprise_mode?
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{endpoint}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

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

Parameters:

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

    Request Query Parameters



231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/crowdin-api/api_resources/reports.rb', line 231

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

#list_user_report_settings_templates(user_id, query = {}) ⇒ Object

Parameters:

  • user_id (Integer) —

    User Identifier

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

    Request Query Parameters



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

def list_user_report_settings_templates(user_id, query = {})
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/users/#{user_id}/reports/settings-templates",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end