Class: Phrase::GitHubSyncApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GitHubSyncApi

Returns a new instance of GitHubSyncApi.



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

def api_client
  @api_client
end

Instance Method Details

#github_sync_export(github_sync_export_parameters, opts = {}) ⇒ nil

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

  • (nil) 


16
17
18
19
 
# File 'lib/phrase/api/git_hub_sync_api.rb', line 16

def github_sync_export(github_sync_export_parameters, opts = {})
  data, _status_code, _headers = github_sync_export_with_http_info(github_sync_export_parameters, opts)
  data
end

#github_sync_export_with_http_info(github_sync_export_parameters, opts = {}) ⇒ Array<(Response, Integer, Hash)>

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

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

    Response<(nil, response status code and response headers



27
28
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
 
# File 'lib/phrase/api/git_hub_sync_api.rb', line 27

def github_sync_export_with_http_info(github_sync_export_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GitHubSyncApi.github_sync_export ...'
  end
  # verify the required parameter 'github_sync_export_parameters' is set
  if @api_client.config.client_side_validation && github_sync_export_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'github_sync_export_parameters' when calling GitHubSyncApi.github_sync_export"
  end
  # resource path
  local_var_path = '/github_syncs/export'

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

#github_sync_import(github_sync_import_parameters, opts = {}) ⇒ nil

Import to Phrase Strings from GitHub Import files to Phrase Strings from your connected GitHub 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) 


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

def github_sync_import(github_sync_import_parameters, opts = {})
  data, _status_code, _headers = github_sync_import_with_http_info(github_sync_import_parameters, opts)
  data
end

#github_sync_import_with_http_info(github_sync_import_parameters, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Import to Phrase Strings from GitHub Import files to Phrase Strings from your connected GitHub 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



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

def github_sync_import_with_http_info(github_sync_import_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GitHubSyncApi.github_sync_import ...'
  end
  # verify the required parameter 'github_sync_import_parameters' is set
  if @api_client.config.client_side_validation && github_sync_import_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'github_sync_import_parameters' when calling GitHubSyncApi.github_sync_import"
  end
  # resource path
  local_var_path = '/github_syncs/import'

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