Module: Crowdin::ApiResources::TranslationMemory

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

Instance Method Summary collapse

Instance Method Details

#add_tm(query = {}) ⇒ Object

Parameters:

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

    Request Body



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

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

#check_tm_export_status(tm_id = nil, export_id = nil) ⇒ Object

Parameters:

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

    TM Identifier

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

    Export Identifier, consists of 36 characters



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

def check_tm_export_status(tm_id = nil, export_id = nil)
  tm_id     || raise_parameter_is_required_error(:tm_id)
  export_id || raise_parameter_is_required_error(:export_id)

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

#check_tm_import_status(tm_id = nil, import_id = nil) ⇒ Object

Parameters:

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

    TM Identifier

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

    Import Identifier, consists of 36 characters



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

def check_tm_import_status(tm_id = nil, import_id = nil)
  tm_id     || raise_parameter_is_required_error(:tm_id)
  import_id || raise_parameter_is_required_error(:import_id)

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

#clear_tm(tm_id = nil) ⇒ Object

Parameters:

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

    TM Identifier



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/crowdin-api/api_resources/translation_memory.rb', line 79

def clear_tm(tm_id = nil)
  tm_id || raise_parameter_is_required_error(:tm_id)

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

#concordance_search_in_tms(body = {}) ⇒ Object

Parameters:

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

    Request Body



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

def concordance_search_in_tms(body = {})
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/tms/concordance",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#create_tm_segment(tm_id, body = {}) ⇒ Object

Parameters:

  • tm_id (Integer) —

    TM Identifier

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

    Request Body



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

def create_tm_segment(tm_id, body = {})
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/tms/#{tm_id}/segments",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#delete_tm(tm_id = nil) ⇒ Object

Parameters:

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

    TM Identifier



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/crowdin-api/api_resources/translation_memory.rb', line 49

def delete_tm(tm_id = nil)
  tm_id || raise_parameter_is_required_error(:tm_id)

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

#delete_tm_segment(tm_id, segment_id) ⇒ Object

Parameters:

  • tm_id (Integer) —

    TM Identifier

  • segment_id (Integer) —

    TM Segment Identifier



247
248
249
250
251
252
253
254
 
# File 'lib/crowdin-api/api_resources/translation_memory.rb', line 247

def delete_tm_segment(tm_id, segment_id)
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/tms/#{tm_id}/segments/#{segment_id}"
  )
  Web::SendRequest.new(request).perform
end

#download_tm(tm_id = nil, export_id = nil, destination = nil) ⇒ Object

Parameters:

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

    TM Identifier

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

    Export Identifier, consists of 36 characters

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

    Destination of File



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

def download_tm(tm_id = nil, export_id = nil, destination = nil)
  tm_id     || raise_parameter_is_required_error(:tm_id)
  export_id || raise_parameter_is_required_error(:export_id)

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

#edit_tm(tm_id = nil, query = {}) ⇒ Object

Parameters:

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

    TM Identifier

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

    Request Body



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/crowdin-api/api_resources/translation_memory.rb', line 64

def edit_tm(tm_id = nil, query = {})
  tm_id || raise_parameter_is_required_error(:tm_id)

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

#edit_tm_segment(tm_id, segment_id, body = []) ⇒ Object

Parameters:

  • tm_id (Integer) —

    TM Identifier

  • segment_id (Integer) —

    TM Segment Identifier

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

    Request Body



274
275
276
277
278
279
280
281
282
 
# File 'lib/crowdin-api/api_resources/translation_memory.rb', line 274

def edit_tm_segment(tm_id, segment_id, body = [])
  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/tms/#{tm_id}/segments/#{segment_id}",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end

#export_tm(tm_id = nil) ⇒ Object

Parameters:

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

    TM Identifier



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

def export_tm(tm_id = nil)
  tm_id || raise_parameter_is_required_error(:tm_id)

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/tms/#{tm_id}/exports"
  )
  Web::SendRequest.new(request).perform
end

#get_tm(tm_id = nil) ⇒ Object

Parameters:

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

    TM Identifier



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

def get_tm(tm_id = nil)
  tm_id || raise_parameter_is_required_error(:tm_id)

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

#get_tm_segment(tm_id, segment_id) ⇒ Object

Parameters:

  • tm_id (Integer) —

    TM Identifier

  • segment_id (Integer) —

    TM Segment Identifier



260
261
262
263
264
265
266
267
 
# File 'lib/crowdin-api/api_resources/translation_memory.rb', line 260

def get_tm_segment(tm_id, segment_id)
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/tms/#{tm_id}/segments/#{segment_id}"
  )
  Web::SendRequest.new(request).perform
end

#import_tm(tm_id = nil, query = {}) ⇒ Object

Parameters:

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

    TM Identifier

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

    Request Body



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/crowdin-api/api_resources/translation_memory.rb', line 141

def import_tm(tm_id = nil, query = {})
  tm_id || raise_parameter_is_required_error(:tm_id)

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

#list_tm_segments(tm_id, query = {}) ⇒ Object

Parameters:

  • tm_id (Integer) —

    TM Identifier

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

    Request Query Parameters



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

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

#list_tms(query = {}) ⇒ Object

Parameters:

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

    Request Query Parameters



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

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

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

Parameters:

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

    Request Body



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

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

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

#tm_segment_batch_operations(tm_id, body = []) ⇒ Object

Parameters:

  • tm_id (Integer) —

    TM Identifier

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

    Request Body



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

def tm_segment_batch_operations(tm_id, body = [])
  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/tms/#{tm_id}/segments",
    { params: body }
  )
  Web::SendRequest.new(request).perform
end