Module: Crowdin::ApiResources::Tasks

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

Instance Method Summary collapse

Instance Method Details

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

Parameters:

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

    Request Body



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

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

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

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

#add_task_comment(task_id = nil, body = {}, project_id = config.project_id) ⇒ Object

Parameters:

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

    Task Identifier

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

    Request Body



166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/crowdin-api/api_resources/tasks.rb', line 166

def add_task_comment(task_id = nil, body = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error
  task_id    || raise_parameter_is_required_error(:task_id)

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

#delete_project_task_settings_template(task_settings_template_id, project_id = config.project_id) ⇒ Object

Parameters:

  • task_settings_template_id (Integer) —

    Task Settings Template Identifier



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

def delete_project_task_settings_template(task_settings_template_id, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

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

#delete_task(task_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Task Identifier



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

def delete_task(task_id = nil, project_id = config.project_id)
  task_id    || raise_parameter_is_required_error(:task_id)
  project_id || raise_project_id_is_required_error

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

#delete_task_comment(task_id = nil, comment_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Task Identifier

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

    Unique identifier for the task comment



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

def delete_task_comment(task_id = nil, comment_id = nil, project_id = config.project_id)
  project_id || raise_project_id_is_required_error
  task_id    || raise_parameter_is_required_error(:task_id)
  comment_id || raise_parameter_is_required_error(:comment_id)

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

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

Parameters:

  • task_settings_template_id (Integer) —

    Task Settings Template Identifier

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

    Request Body



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

def edit_project_task_settings_template(task_settings_template_id, 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}/tasks/settings-templates/#{task_settings_template_id}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#edit_task(task_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

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

    Task Identifier

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

    Request Body



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

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

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

#edit_task_archived_status(task_id = nil, query = {}) ⇒ Object

Parameters:

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

    Task Identifier

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

    Request Body



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

def edit_task_archived_status(task_id = nil, query = {})
  task_id || raise_parameter_is_required_error(:task_id)

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/user/tasks/#{task_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#edit_task_comment(task_id = nil, comment_id = nil, body = {}, project_id = config.project_id) ⇒ Object

Parameters:

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

    Task Identifier

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

    Unique identifier for the task comment

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

    Request Body



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/crowdin-api/api_resources/tasks.rb', line 184

def edit_task_comment(task_id = nil, comment_id = nil, body = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error
  task_id    || raise_parameter_is_required_error(:task_id)
  comment_id || raise_parameter_is_required_error(:comment_id)

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

#export_task_strings(task_id = nil, destination = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Task Identifier

  • 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/tasks.rb', line 40

def export_task_strings(task_id = nil, destination = nil, project_id = config.project_id)
  task_id    || raise_parameter_is_required_error(:task_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}/exports"
  )
  Web::SendRequest.new(request, destination).perform
end

#get_project_task_settings_template(task_settings_template_id, project_id = config.project_id) ⇒ Object

Parameters:

  • task_settings_template_id (Integer) —

    Task Settings Template Identifier



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

def get_project_task_settings_template(task_settings_template_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}/tasks/settings-templates/#{task_settings_template_id}"
  )
  Web::SendRequest.new(request).perform
end

#get_task(task_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Task Identifier



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

def get_task(task_id = nil, project_id = config.project_id)
  task_id    || raise_parameter_is_required_error(:task_id)
  project_id || raise_project_id_is_required_error

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

#get_task_comment(task_id = nil, comment_id = nil, project_id = config.project_id) ⇒ Object

Parameters:

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

    Task Identifier

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

    Unique identifier for the task comment



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/crowdin-api/api_resources/tasks.rb', line 149

def get_task_comment(task_id = nil, comment_id = nil, project_id = config.project_id)
  project_id || raise_project_id_is_required_error
  task_id    || raise_parameter_is_required_error(:task_id)
  comment_id || raise_parameter_is_required_error(:comment_id)

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

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

Parameters:

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

    Request Query Parameters



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

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

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

Parameters:

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

    Request Query Parameters

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

    User Identifier (Crowdin only)



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/crowdin-api/api_resources/tasks.rb', line 293

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

  endpoint = 'tasks'
  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_task_comments(task_id = nil, query = {}, project_id = config.project_id) ⇒ Object

Parameters:

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

    Task Identifier

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

    Request Query Parameters



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

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

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

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

Parameters:

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

    Request Query Parameters



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

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

#list_user_tasks(query = {}) ⇒ Object

Parameters:

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

    Request Query Parameters



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

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