Class: Phrase::LinkedKeysApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LinkedKeysApi

Returns a new instance of LinkedKeysApi.



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

def api_client
  @api_client
end

Instance Method Details

Batch unlink child keys from a parent key Unlinks multiple child keys from a given parent key in a single operation.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    Parent Translation Key ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (nil) 


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

def key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, opts = {})
  data, _status_code, _headers = key_links_batch_destroy_with_http_info(project_id, id, key_links_batch_destroy_parameters, opts)
  data
end

#key_links_batch_destroy_with_http_info(project_id, id, key_links_batch_destroy_parameters, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Batch unlink child keys from a parent key Unlinks multiple child keys from a given parent key in a single operation.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    Parent Translation Key ID

  • key_links_batch_destroy_parameters (KeyLinksBatchDestroyParameters)
  • 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



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/linked_keys_api.rb', line 31

def key_links_batch_destroy_with_http_info(project_id, id, key_links_batch_destroy_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinkedKeysApi.key_links_batch_destroy ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling LinkedKeysApi.key_links_batch_destroy"
  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 LinkedKeysApi.key_links_batch_destroy"
  end
  # verify the required parameter 'key_links_batch_destroy_parameters' is set
  if @api_client.config.client_side_validation && key_links_batch_destroy_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'key_links_batch_destroy_parameters' when calling LinkedKeysApi.key_links_batch_destroy"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{id}/key_links'.sub('{' + 'project_id' + '}', CGI.escape(project_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(key_links_batch_destroy_parameters) 

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

#key_links_create(project_id, id, key_links_create_parameters, opts = {}) ⇒ KeyLink

Link child keys to a parent key Creates links between a given parent key and one or more child keys.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    Parent Translation Key ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



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

def key_links_create(project_id, id, key_links_create_parameters, opts = {})
  data, _status_code, _headers = key_links_create_with_http_info(project_id, id, key_links_create_parameters, opts)
  data
end

#key_links_create_with_http_info(project_id, id, key_links_create_parameters, opts = {}) ⇒ Array<(Response<(KeyLink)>, Integer, Hash)>

Link child keys to a parent key Creates links between a given parent key and one or more child keys.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    Parent Translation Key ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

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

    Response<(KeyLink)> data, 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
165
166
167
168
 
# File 'lib/phrase/api/linked_keys_api.rb', line 111

def key_links_create_with_http_info(project_id, id, key_links_create_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinkedKeysApi.key_links_create ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling LinkedKeysApi.key_links_create"
  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 LinkedKeysApi.key_links_create"
  end
  # verify the required parameter 'key_links_create_parameters' is set
  if @api_client.config.client_side_validation && key_links_create_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'key_links_create_parameters' when calling LinkedKeysApi.key_links_create"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{id}/key_links'.sub('{' + 'project_id' + '}', CGI.escape(project_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(key_links_create_parameters) 

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

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

#key_links_destroy(project_id, id, child_key_id, opts = {}) ⇒ nil

Unlink a child key from a parent key Unlinks a single child key from a given parent key.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    Parent Translation Key ID

  • child_key_id (String) —

    The ID of the child key to unlink.

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (nil) 


178
179
180
181
 
# File 'lib/phrase/api/linked_keys_api.rb', line 178

def key_links_destroy(project_id, id, child_key_id, opts = {})
  data, _status_code, _headers = key_links_destroy_with_http_info(project_id, id, child_key_id, opts)
  data
end

#key_links_destroy_with_http_info(project_id, id, child_key_id, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Unlink a child key from a parent key Unlinks a single child key from a given parent key.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    Parent Translation Key ID

  • child_key_id (String) —

    The ID of the child key to unlink.

  • 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



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
243
244
245
246
 
# File 'lib/phrase/api/linked_keys_api.rb', line 191

def key_links_destroy_with_http_info(project_id, id, child_key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinkedKeysApi.key_links_destroy ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling LinkedKeysApi.key_links_destroy"
  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 LinkedKeysApi.key_links_destroy"
  end
  # verify the required parameter 'child_key_id' is set
  if @api_client.config.client_side_validation && child_key_id.nil?
    fail ArgumentError, "Missing the required parameter 'child_key_id' when calling LinkedKeysApi.key_links_destroy"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{id}/key_links/{child_key_id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'child_key_id' + '}', CGI.escape(child_key_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] 

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

#key_links_index(project_id, id, opts = {}) ⇒ KeyLink

List child keys of a parent key Returns detailed information about a parent key, including its linked child keys.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    Parent Translation Key ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



255
256
257
258
 
# File 'lib/phrase/api/linked_keys_api.rb', line 255

def key_links_index(project_id, id, opts = {})
  data, _status_code, _headers = key_links_index_with_http_info(project_id, id, opts)
  data
end

#key_links_index_with_http_info(project_id, id, opts = {}) ⇒ Array<(Response<(KeyLink)>, Integer, Hash)>

List child keys of a parent key Returns detailed information about a parent key, including its linked child keys.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    Parent Translation Key ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

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

    Response<(KeyLink)> 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
 
# File 'lib/phrase/api/linked_keys_api.rb', line 267

def key_links_index_with_http_info(project_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinkedKeysApi.key_links_index ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling LinkedKeysApi.key_links_index"
  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 LinkedKeysApi.key_links_index"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{id}/key_links'.sub('{' + 'project_id' + '}', CGI.escape(project_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] || 'KeyLink' 

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