Module: Crowdin::ApiResources::Glossaries

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

Instance Method Summary collapse

Instance Method Details

#add_glossary(query = {}) ⇒ Object

Parameters:

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

    Request Body



22
23
24
25
26
27
28
29
30
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 22

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

#add_term(glossary_id = nil, query = {}) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Request Body



180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 180

def add_term(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

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

#check_glossary_export_status(glossary_id = nil, export_id = nil) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Export Identifier, consists of 36 characters



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 99

def check_glossary_export_status(glossary_id = nil, export_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  export_id   || raise_parameter_is_required_error(:export_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/exports/#{export_id}"
  )
  Web::SendRequest.new(request).perform
end

#check_glossary_import_status(glossary_id = nil, import_id = nil) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Import Identifier, consists of 36 characters



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

def check_glossary_import_status(glossary_id = nil, import_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  import_id   || raise_parameter_is_required_error(:import_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/imports/#{import_id}"
  )
  Web::SendRequest.new(request).perform
end

#clear_glossary(glossary_id = nil, query = {}) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Request Body



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 196

def clear_glossary(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  response = ::RestClient::Request.execute(
    {
      method: :delete,
      url: config.base_url + config.target_api_url + "/glossaries/#{glossary_id}/terms",
      payload: query.to_json
    }.merge(@options)
  )

  response.body.empty? ? response.code : JSON.parse(response.body)
rescue StandardError => e
  e.message
end

#delete_concept(glossary_id = nil, concept_id = nil) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Concept Identifier



316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 316

def delete_concept(glossary_id = nil, concept_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  concept_id || raise_parameter_is_required_error(:concept_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}"
  )
  Web::SendRequest.new(request).perform
end

#delete_glossary(glossary_id = nil) ⇒ Object

Parameters:

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

    Glossary Identifier



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 51

def delete_glossary(glossary_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/glossaries/#{glossary_id}"
  )
  Web::SendRequest.new(request).perform
end

#delete_term(glossary_id = nil, term_id = nil) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Term Identifier



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

def delete_term(glossary_id = nil, term_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  term_id     || raise_parameter_is_required_error(:term_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}"
  )
  Web::SendRequest.new(request).perform
end

#download_glossary(glossary_id = nil, export_id = nil, destination = nil) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Export Identifier, consists of 36 characters

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

    File destination



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

def download_glossary(glossary_id = nil, export_id = nil, destination = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  export_id   || raise_parameter_is_required_error(:export_id)

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

#edit_glossary(glossary_id = nil, query = {}) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Request Body



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 66

def edit_glossary(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

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

#edit_term(glossary_id = nil, term_id = nil, query = {}) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Term Identifier

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

    Request Body



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

def edit_term(glossary_id = nil, term_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  term_id     || raise_parameter_is_required_error(:term_id)

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#export_glossary(query = {}, glossary_id = nil, destination = nil) ⇒ Object

Parameters:

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

    Request Body

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

    Glossary Identifier

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

    File destination



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 83

def export_glossary(query = {}, glossary_id = nil, destination = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)

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

#get_concept(glossary_id = nil, concept_id = nil) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Concept Identifier



282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 282

def get_concept(glossary_id = nil, concept_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  concept_id || raise_parameter_is_required_error(:concept_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}"
  )
  Web::SendRequest.new(request).perform
end

#get_glossary(glossary_id = nil, query = {}) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Request Body



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 36

def get_glossary(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

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

#get_term(glossary_id = nil, term_id = nil) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Term Identifier



216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 216

def get_term(glossary_id = nil, term_id = nil)
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  term_id     || raise_parameter_is_required_error(:term_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/glossaries/#{glossary_id}/terms/#{term_id}"
  )
  Web::SendRequest.new(request).perform
end

#import_glossary(glossary_id = nil, query = {}) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Request Body



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

def import_glossary(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

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

#list_concepts(glossary_id = nil, query = {}) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Request Body



266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 266

def list_concepts(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

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

#list_glossaries(query = {}) ⇒ Object

Parameters:

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

    Request Body



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

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

#list_terms(glossary_id = nil, query = {}) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Request Body



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

def list_terms(glossary_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)

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

#search_glossaries_concordance(project_id = nil, query = {}) ⇒ Object

Parameters:

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

    Project Identifier

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

    Request Body



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/crowdin-api/api_resources/glossaries.rb', line 332

def search_glossaries_concordance(project_id = nil, query = {})
  project_id || raise_project_id_is_required_error

  %i[source_language_id target_language_id expression].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}/glossaries/concordance",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end

#update_concept(glossary_id = nil, concept_id = nil, query = {}) ⇒ Object

Parameters:

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

    Glossary Identifier

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

    Concept Identifier

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

    Request Body



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

def update_concept(glossary_id = nil, concept_id = nil, query = {})
  glossary_id || raise_parameter_is_required_error(:glossary_id)
  concept_id || raise_parameter_is_required_error(:concept_id)

  request = Web::Request.new(
    connection,
    :put,
    "#{config.target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end