Class: Phrase::BitbucketSyncApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BitbucketSyncApi

Returns a new instance of BitbucketSyncApi.



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

def api_client
  @api_client
end

Instance Method Details

#bitbucket_sync_export(id, bitbucket_sync_export_parameters, opts = {}) ⇒ BitbucketSyncExportResponse

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

Parameters:

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



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

def bitbucket_sync_export(id, bitbucket_sync_export_parameters, opts = {})
  data, _status_code, _headers = bitbucket_sync_export_with_http_info(id, bitbucket_sync_export_parameters, opts)
  data
end

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

Export from Phrase Strings to Bitbucket Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket 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:

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



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
76
77
78
79
80
81
82
 
# File 'lib/phrase/api/bitbucket_sync_api.rb', line 29

def bitbucket_sync_export_with_http_info(id, bitbucket_sync_export_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BitbucketSyncApi.bitbucket_sync_export ...'
  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 BitbucketSyncApi.bitbucket_sync_export"
  end
  # verify the required parameter 'bitbucket_sync_export_parameters' is set
  if @api_client.config.client_side_validation && bitbucket_sync_export_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'bitbucket_sync_export_parameters' when calling BitbucketSyncApi.bitbucket_sync_export"
  end
  # resource path
  local_var_path = '/bitbucket_syncs/{id}/export'.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(bitbucket_sync_export_parameters) 

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

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

#bitbucket_sync_import(id, bitbucket_sync_import_parameters, opts = {}) ⇒ nil

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

Parameters:

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/phrase/api/bitbucket_sync_api.rb', line 91

def bitbucket_sync_import(id, bitbucket_sync_import_parameters, opts = {})
  data, _status_code, _headers = bitbucket_sync_import_with_http_info(id, bitbucket_sync_import_parameters, opts)
  data
end

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

Import to Phrase Strings from Bitbucket Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket 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:

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



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
150
151
152
153
154
 
# File 'lib/phrase/api/bitbucket_sync_api.rb', line 103

def bitbucket_sync_import_with_http_info(id, bitbucket_sync_import_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BitbucketSyncApi.bitbucket_sync_import ...'
  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 BitbucketSyncApi.bitbucket_sync_import"
  end
  # verify the required parameter 'bitbucket_sync_import_parameters' is set
  if @api_client.config.client_side_validation && bitbucket_sync_import_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'bitbucket_sync_import_parameters' when calling BitbucketSyncApi.bitbucket_sync_import"
  end
  # resource path
  local_var_path = '/bitbucket_syncs/{id}/import'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(bitbucket_sync_import_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BitbucketSyncApi#bitbucket_sync_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#bitbucket_syncs_list(opts = {}) ⇒ Array<BitbucketSync>

List Bitbucket syncs List all Bitbucket repositories for which synchronisation with Phrase Strings 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 project should be created in. Required if the requesting user is a member of multiple accounts.

Returns:



162
163
164
165
 
# File 'lib/phrase/api/bitbucket_sync_api.rb', line 162

def bitbucket_syncs_list(opts = {})
  data, _status_code, _headers = bitbucket_syncs_list_with_http_info(opts)
  data
end

#bitbucket_syncs_list_with_http_info(opts = {}) ⇒ Array<(Response<(Array<BitbucketSync>)>, Integer, Hash)>

List Bitbucket syncs List all Bitbucket repositories for which synchronisation with Phrase Strings 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 project should be created in. Required if the requesting user is a member of multiple accounts.

Returns:

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

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



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

def bitbucket_syncs_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BitbucketSyncApi.bitbucket_syncs_list ...'
  end
  # resource path
  local_var_path = '/bitbucket_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<BitbucketSync>' 

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