Class: Phrase::GlossaryTermsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phrase/api/glossary_terms_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GlossaryTermsApi

Returns a new instance of GlossaryTermsApi.



7
8
9
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#glossary_term_create(account_id, glossary_id, glossary_term_create_parameters, opts = {}) ⇒ GlossaryTerm

Create a term Create a new term in a term base (previously: glossary).

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • glossary_term_create_parameters (GlossaryTermCreateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



18
19
20
21
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 18

def glossary_term_create(, glossary_id, glossary_term_create_parameters, opts = {})
  data, _status_code, _headers = glossary_term_create_with_http_info(, glossary_id, glossary_term_create_parameters, opts)
  data
end

#glossary_term_create_with_http_info(account_id, glossary_id, glossary_term_create_parameters, opts = {}) ⇒ Array<(Response<(GlossaryTerm)>, Integer, Hash)>

Create a term Create a new term in a term base (previously: glossary).

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • glossary_term_create_parameters (GlossaryTermCreateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(GlossaryTerm)>, Integer, Hash)>) —

    Response<(GlossaryTerm)> data, response status code and response headers



31
32
33
34
35
36
37
38
39
40
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
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 31

def glossary_term_create_with_http_info(, glossary_id, glossary_term_create_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_create ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_create"
  end
  # verify the required parameter 'glossary_id' is set
  if @api_client.config.client_side_validation && glossary_id.nil?
    fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_create"
  end
  # verify the required parameter 'glossary_term_create_parameters' is set
  if @api_client.config.client_side_validation && glossary_term_create_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'glossary_term_create_parameters' when calling GlossaryTermsApi.glossary_term_create"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms'.sub('{' + 'account_id' + '}', CGI.escape(.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

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

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

  # return_type
  return_type = opts[:return_type] || 'GlossaryTerm' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :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: GlossaryTermsApi#glossary_term_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#glossary_term_delete(account_id, glossary_id, id, opts = {}) ⇒ nil

Delete a term Delete an existing term in a term base (previously: glossary).

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (nil) 


98
99
100
101
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 98

def glossary_term_delete(, glossary_id, id, opts = {})
  data, _status_code, _headers = glossary_term_delete_with_http_info(, glossary_id, id, opts)
  data
end

#glossary_term_delete_with_http_info(account_id, glossary_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Delete a term Delete an existing term in a term base (previously: glossary).

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response, Integer, Hash)>) —

    Response<(nil, response status code and response headers



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 111

def glossary_term_delete_with_http_info(, glossary_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_delete ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_delete"
  end
  # verify the required parameter 'glossary_id' is set
  if @api_client.config.client_side_validation && glossary_id.nil?
    fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_delete"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermsApi.glossary_term_delete"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}'.sub('{' + 'account_id' + '}', CGI.escape(.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :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: GlossaryTermsApi#glossary_term_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#glossary_term_show(account_id, glossary_id, id, opts = {}) ⇒ GlossaryTerm

Get a single term Get details for a single term in the term base (previously: glossary).

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



174
175
176
177
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 174

def glossary_term_show(, glossary_id, id, opts = {})
  data, _status_code, _headers = glossary_term_show_with_http_info(, glossary_id, id, opts)
  data
end

#glossary_term_show_with_http_info(account_id, glossary_id, id, opts = {}) ⇒ Array<(Response<(GlossaryTerm)>, Integer, Hash)>

Get a single term Get details for a single term in the term base (previously: glossary).

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(GlossaryTerm)>, Integer, Hash)>) —

    Response<(GlossaryTerm)> data, response status code and response headers



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 187

def glossary_term_show_with_http_info(, glossary_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_show ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_show"
  end
  # verify the required parameter 'glossary_id' is set
  if @api_client.config.client_side_validation && glossary_id.nil?
    fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_show"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermsApi.glossary_term_show"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}'.sub('{' + 'account_id' + '}', CGI.escape(.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

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

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

  # return_type
  return_type = opts[:return_type] || 'GlossaryTerm' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :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: GlossaryTermsApi#glossary_term_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#glossary_term_update(account_id, glossary_id, id, glossary_term_update_parameters, opts = {}) ⇒ GlossaryTerm

Update a term Update an existing term in a term base (previously: glossary).

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • id (String) —

    ID

  • glossary_term_update_parameters (GlossaryTermUpdateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



253
254
255
256
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 253

def glossary_term_update(, glossary_id, id, glossary_term_update_parameters, opts = {})
  data, _status_code, _headers = glossary_term_update_with_http_info(, glossary_id, id, glossary_term_update_parameters, opts)
  data
end

#glossary_term_update_with_http_info(account_id, glossary_id, id, glossary_term_update_parameters, opts = {}) ⇒ Array<(Response<(GlossaryTerm)>, Integer, Hash)>

Update a term Update an existing term in a term base (previously: glossary).

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • id (String) —

    ID

  • glossary_term_update_parameters (GlossaryTermUpdateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(GlossaryTerm)>, Integer, Hash)>) —

    Response<(GlossaryTerm)> data, response status code and response headers



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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 267

def glossary_term_update_with_http_info(, glossary_id, id, glossary_term_update_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_update ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_update"
  end
  # verify the required parameter 'glossary_id' is set
  if @api_client.config.client_side_validation && glossary_id.nil?
    fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_update"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermsApi.glossary_term_update"
  end
  # verify the required parameter 'glossary_term_update_parameters' is set
  if @api_client.config.client_side_validation && glossary_term_update_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'glossary_term_update_parameters' when calling GlossaryTermsApi.glossary_term_update"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}'.sub('{' + 'account_id' + '}', CGI.escape(.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

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

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

  # return_type
  return_type = opts[:return_type] || 'GlossaryTerm' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_term_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#glossary_terms_list(account_id, glossary_id, opts = {}) ⇒ Array<GlossaryTerm>

List terms List all terms in term bases (previously: glossary) that the current user has access to.

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

Returns:



339
340
341
342
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 339

def glossary_terms_list(, glossary_id, opts = {})
  data, _status_code, _headers = glossary_terms_list_with_http_info(, glossary_id, opts)
  data
end

#glossary_terms_list_with_http_info(account_id, glossary_id, opts = {}) ⇒ Array<(Response<(Array<GlossaryTerm>)>, Integer, Hash)>

List terms List all terms in term bases (previously: glossary) that the current user has access to.

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

Returns:

  • (Array<(Response<(Array<GlossaryTerm>)>, Integer, Hash)>) —

    Response<(Array<GlossaryTerm>)> data, response status code and response headers



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
 
# File 'lib/phrase/api/glossary_terms_api.rb', line 353

def glossary_terms_list_with_http_info(, glossary_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_terms_list ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_terms_list"
  end
  # verify the required parameter 'glossary_id' is set
  if @api_client.config.client_side_validation && glossary_id.nil?
    fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_terms_list"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms'.sub('{' + 'account_id' + '}', CGI.escape(.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

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

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

  # return_type
  return_type = opts[:return_type] || 'Array<GlossaryTerm>' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :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: GlossaryTermsApi#glossary_terms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end