Class: Phrase::GitLabSyncApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GitLabSyncApi

Returns a new instance of GitLabSyncApi.



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

def api_client
  @api_client
end

Instance Method Details

#gitlab_sync_delete(id, opts = {}) ⇒ nil

Delete single Sync Setting Deletes a single GitLab Sync Setting.

Parameters:

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

Returns:

  • (nil) 


17
18
19
20
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 17

def gitlab_sync_delete(id, opts = {})
  data, _status_code, _headers = gitlab_sync_delete_with_http_info(id, opts)
  data
end

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

Delete single Sync Setting Deletes a single GitLab Sync Setting.

Parameters:

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

Returns:

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

    Response<(nil, response status code and response headers



29
30
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
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 29

def gitlab_sync_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_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 GitLabSyncApi.gitlab_sync_delete"
  end
  # resource path
  local_var_path = '/gitlab_syncs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

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

#gitlab_sync_export(gitlab_sync_id, gitlab_sync_export_parameters, opts = {}) ⇒ GitlabSyncExport

Export from Phrase Strings to GitLab Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository.
Note: Export is done asynchronously and may take several seconds depending on the project size.

Parameters:

  • gitlab_sync_id (String) —

    Gitlab Sync ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



84
85
86
87
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 84

def gitlab_sync_export(gitlab_sync_id, gitlab_sync_export_parameters, opts = {})
  data, _status_code, _headers = gitlab_sync_export_with_http_info(gitlab_sync_id, gitlab_sync_export_parameters, opts)
  data
end

#gitlab_sync_export_with_http_info(gitlab_sync_id, gitlab_sync_export_parameters, opts = {}) ⇒ Array<(Response<(GitlabSyncExport)>, Integer, Hash)>

Export from Phrase Strings to GitLab Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Export is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;

Parameters:

  • gitlab_sync_id (String) —

    Gitlab Sync ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

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

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 96

def gitlab_sync_export_with_http_info(gitlab_sync_id, gitlab_sync_export_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_export ...'
  end
  # verify the required parameter 'gitlab_sync_id' is set
  if @api_client.config.client_side_validation && gitlab_sync_id.nil?
    fail ArgumentError, "Missing the required parameter 'gitlab_sync_id' when calling GitLabSyncApi.gitlab_sync_export"
  end
  # verify the required parameter 'gitlab_sync_export_parameters' is set
  if @api_client.config.client_side_validation && gitlab_sync_export_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'gitlab_sync_export_parameters' when calling GitLabSyncApi.gitlab_sync_export"
  end
  # resource path
  local_var_path = '/gitlab_syncs/{gitlab_sync_id}/export'.sub('{' + 'gitlab_sync_id' + '}', CGI.escape(gitlab_sync_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(gitlab_sync_export_parameters) 

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

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

#gitlab_sync_history(gitlab_sync_id, opts = {}) ⇒ Array<GitlabSyncHistory>

History of single Sync Setting List history for a single Sync Setting.

Parameters:

  • gitlab_sync_id (String) —

    Gitlab Sync 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

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

Returns:



160
161
162
163
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 160

def gitlab_sync_history(gitlab_sync_id, opts = {})
  data, _status_code, _headers = gitlab_sync_history_with_http_info(gitlab_sync_id, opts)
  data
end

#gitlab_sync_history_with_http_info(gitlab_sync_id, opts = {}) ⇒ Array<(Response<(Array<GitlabSyncHistory>)>, Integer, Hash)>

History of single Sync Setting List history for a single Sync Setting.

Parameters:

  • gitlab_sync_id (String) —

    Gitlab Sync 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

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

Returns:

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

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



174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 174

def gitlab_sync_history_with_http_info(gitlab_sync_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_history ...'
  end
  # verify the required parameter 'gitlab_sync_id' is set
  if @api_client.config.client_side_validation && gitlab_sync_id.nil?
    fail ArgumentError, "Missing the required parameter 'gitlab_sync_id' when calling GitLabSyncApi.gitlab_sync_history"
  end
  # resource path
  local_var_path = '/gitlab_syncs/{gitlab_sync_id}/history'.sub('{' + 'gitlab_sync_id' + '}', CGI.escape(gitlab_sync_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?
  query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].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<GitlabSyncHistory>' 

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

#gitlab_sync_import(gitlab_sync_id, gitlab_sync_import_parameters, opts = {}) ⇒ Array<Upload>

Import from GitLab to Phrase Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository.
Note: Import is done asynchronously and may take several seconds depending on the project size.

Parameters:

  • gitlab_sync_id (String) —

    Gitlab Sync ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



233
234
235
236
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 233

def gitlab_sync_import(gitlab_sync_id, gitlab_sync_import_parameters, opts = {})
  data, _status_code, _headers = gitlab_sync_import_with_http_info(gitlab_sync_id, gitlab_sync_import_parameters, opts)
  data
end

#gitlab_sync_import_with_http_info(gitlab_sync_id, gitlab_sync_import_parameters, opts = {}) ⇒ Array<(Response<(Array<Upload>)>, Integer, Hash)>

Import from GitLab to Phrase Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Import is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;

Parameters:

  • gitlab_sync_id (String) —

    Gitlab Sync ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

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

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



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

def gitlab_sync_import_with_http_info(gitlab_sync_id, gitlab_sync_import_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_import ...'
  end
  # verify the required parameter 'gitlab_sync_id' is set
  if @api_client.config.client_side_validation && gitlab_sync_id.nil?
    fail ArgumentError, "Missing the required parameter 'gitlab_sync_id' when calling GitLabSyncApi.gitlab_sync_import"
  end
  # verify the required parameter 'gitlab_sync_import_parameters' is set
  if @api_client.config.client_side_validation && gitlab_sync_import_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'gitlab_sync_import_parameters' when calling GitLabSyncApi.gitlab_sync_import"
  end
  # resource path
  local_var_path = '/gitlab_syncs/{gitlab_sync_id}/import'.sub('{' + 'gitlab_sync_id' + '}', CGI.escape(gitlab_sync_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(gitlab_sync_import_parameters) 

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

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

#gitlab_sync_list(opts = {}) ⇒ Array<GitlabSync>

List GitLab syncs List all GitLab Sync Settings for which synchronisation with Phrase Strings and GitLab is activated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

Returns:



306
307
308
309
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 306

def gitlab_sync_list(opts = {})
  data, _status_code, _headers = gitlab_sync_list_with_http_info(opts)
  data
end

#gitlab_sync_list_with_http_info(opts = {}) ⇒ Array<(Response<(Array<GitlabSync>)>, Integer, Hash)>

List GitLab syncs List all GitLab Sync Settings for which synchronisation with Phrase Strings and GitLab is activated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

Returns:

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

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 317

def gitlab_sync_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_list ...'
  end
  # resource path
  local_var_path = '/gitlab_syncs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].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<GitlabSync>' 

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

#gitlab_sync_show(id, opts = {}) ⇒ GitlabSync

Get single Sync Setting Shows a single GitLab Sync Setting.

Parameters:

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

Returns:



370
371
372
373
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 370

def gitlab_sync_show(id, opts = {})
  data, _status_code, _headers = gitlab_sync_show_with_http_info(id, opts)
  data
end

#gitlab_sync_show_with_http_info(id, opts = {}) ⇒ Array<(Response<(GitlabSync)>, Integer, Hash)>

Get single Sync Setting Shows a single GitLab Sync Setting.

Parameters:

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

Returns:

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

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



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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 382

def gitlab_sync_show_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_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 GitLabSyncApi.gitlab_sync_show"
  end
  # resource path
  local_var_path = '/gitlab_syncs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].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] || 'GitlabSync' 

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

#gitlab_sync_update(id, opts = {}) ⇒ GitlabSync

Update single Sync Setting Updates a single GitLab Sync Setting.

Parameters:

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

  • :phrase_project_code (String) —

    Code of the related Phrase Strings Project.

  • :gitlab_project_id (Integer) —

    ID of the related GitLab Project.

  • :gitlab_branch_name (String) —

    Name of the GitLab Branch.

Returns:



442
443
444
445
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 442

def gitlab_sync_update(id, opts = {})
  data, _status_code, _headers = gitlab_sync_update_with_http_info(id, opts)
  data
end

#gitlab_sync_update_with_http_info(id, opts = {}) ⇒ Array<(Response<(GitlabSync)>, Integer, Hash)>

Update single Sync Setting Updates a single GitLab Sync Setting.

Parameters:

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :account_id (String) —

    Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

  • :phrase_project_code (String) —

    Code of the related Phrase Strings Project.

  • :gitlab_project_id (Integer) —

    ID of the related GitLab Project.

  • :gitlab_branch_name (String) —

    Name of the GitLab Branch.

Returns:

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

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



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/phrase/api/git_lab_sync_api.rb', line 457

def gitlab_sync_update_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_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 GitLabSyncApi.gitlab_sync_update"
  end
  # resource path
  local_var_path = '/gitlab_syncs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'phrase_project_code'] = opts[:'phrase_project_code'] if !opts[:'phrase_project_code'].nil?
  query_params[:'gitlab_project_id'] = opts[:'gitlab_project_id'] if !opts[:'gitlab_project_id'].nil?
  query_params[:'gitlab_branch_name'] = opts[:'gitlab_branch_name'] if !opts[:'gitlab_branch_name'].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] || 'GitlabSync' 

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