Class: Phrase::GlossaryTermTranslationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GlossaryTermTranslationsApi

Returns a new instance of GlossaryTermTranslationsApi.



7
8
9
 
# File 'lib/phrase/api/glossary_term_translations_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_term_translations_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#glossary_term_translation_create(account_id, glossary_id, term_id, glossary_term_translation_create_parameters, opts = {}) ⇒ GlossaryTermTranslation

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

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • term_id (String) —

    Term ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



19
20
21
22
 
# File 'lib/phrase/api/glossary_term_translations_api.rb', line 19

def glossary_term_translation_create(, glossary_id, term_id, glossary_term_translation_create_parameters, opts = {})
  data, _status_code, _headers = glossary_term_translation_create_with_http_info(, glossary_id, term_id, glossary_term_translation_create_parameters, opts)
  data
end

#glossary_term_translation_create_with_http_info(account_id, glossary_id, term_id, glossary_term_translation_create_parameters, opts = {}) ⇒ Array<(Response<(GlossaryTermTranslation)>, Integer, Hash)>

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

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • term_id (String) —

    Term ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



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
89
90
91
92
93
94
 
# File 'lib/phrase/api/glossary_term_translations_api.rb', line 33

def glossary_term_translation_create_with_http_info(, glossary_id, term_id, glossary_term_translation_create_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlossaryTermTranslationsApi.glossary_term_translation_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 GlossaryTermTranslationsApi.glossary_term_translation_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 GlossaryTermTranslationsApi.glossary_term_translation_create"
  end
  # verify the required parameter 'term_id' is set
  if @api_client.config.client_side_validation && term_id.nil?
    fail ArgumentError, "Missing the required parameter 'term_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_create"
  end
  # verify the required parameter 'glossary_term_translation_create_parameters' is set
  if @api_client.config.client_side_validation && glossary_term_translation_create_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'glossary_term_translation_create_parameters' when calling GlossaryTermTranslationsApi.glossary_term_translation_create"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations'.sub('{' + 'account_id' + '}', CGI.escape(.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'term_id' + '}', CGI.escape(term_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_translation_create_parameters) 

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

  # 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: GlossaryTermTranslationsApi#glossary_term_translation_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_translation_delete(account_id, glossary_id, term_id, id, opts = {}) ⇒ nil

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

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • term_id (String) —

    Term 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) 


105
106
107
108
 
# File 'lib/phrase/api/glossary_term_translations_api.rb', line 105

def glossary_term_translation_delete(, glossary_id, term_id, id, opts = {})
  data, _status_code, _headers = glossary_term_translation_delete_with_http_info(, glossary_id, term_id, id, opts)
  data
end

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

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

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • term_id (String) —

    Term 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



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
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/phrase/api/glossary_term_translations_api.rb', line 119

def glossary_term_translation_delete_with_http_info(, glossary_id, term_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlossaryTermTranslationsApi.glossary_term_translation_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 GlossaryTermTranslationsApi.glossary_term_translation_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 GlossaryTermTranslationsApi.glossary_term_translation_delete"
  end
  # verify the required parameter 'term_id' is set
  if @api_client.config.client_side_validation && term_id.nil?
    fail ArgumentError, "Missing the required parameter 'term_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_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 GlossaryTermTranslationsApi.glossary_term_translation_delete"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'term_id' + '}', CGI.escape(term_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: GlossaryTermTranslationsApi#glossary_term_translation_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_translation_update(account_id, glossary_id, term_id, id, glossary_term_translation_update_parameters, opts = {}) ⇒ GlossaryTermTranslation

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

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • term_id (String) —

    Term ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



188
189
190
191
 
# File 'lib/phrase/api/glossary_term_translations_api.rb', line 188

def glossary_term_translation_update(, glossary_id, term_id, id, glossary_term_translation_update_parameters, opts = {})
  data, _status_code, _headers = glossary_term_translation_update_with_http_info(, glossary_id, term_id, id, glossary_term_translation_update_parameters, opts)
  data
end

#glossary_term_translation_update_with_http_info(account_id, glossary_id, term_id, id, glossary_term_translation_update_parameters, opts = {}) ⇒ Array<(Response<(GlossaryTermTranslation)>, Integer, Hash)>

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

Parameters:

  • account_id (String) —

    Account ID

  • glossary_id (String) —

    Glossary ID

  • term_id (String) —

    Term ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/phrase/api/glossary_term_translations_api.rb', line 203

def glossary_term_translation_update_with_http_info(, glossary_id, term_id, id, glossary_term_translation_update_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlossaryTermTranslationsApi.glossary_term_translation_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 GlossaryTermTranslationsApi.glossary_term_translation_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 GlossaryTermTranslationsApi.glossary_term_translation_update"
  end
  # verify the required parameter 'term_id' is set
  if @api_client.config.client_side_validation && term_id.nil?
    fail ArgumentError, "Missing the required parameter 'term_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_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 GlossaryTermTranslationsApi.glossary_term_translation_update"
  end
  # verify the required parameter 'glossary_term_translation_update_parameters' is set
  if @api_client.config.client_side_validation && glossary_term_translation_update_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'glossary_term_translation_update_parameters' when calling GlossaryTermTranslationsApi.glossary_term_translation_update"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'term_id' + '}', CGI.escape(term_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_translation_update_parameters) 

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

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