Class: Phrase::LocaleDownloadsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LocaleDownloadsApi

Returns a new instance of LocaleDownloadsApi.



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

def api_client
  @api_client
end

Instance Method Details

#locale_download_create(project_id, locale_id, locale_download_create_parameters, opts = {}) ⇒ LocaleDownload

Initiate async download of a locale Prepare a locale for download in a specific file format.

Parameters:

  • project_id (String) —

    Project ID

  • locale_id (String) —

    Locale ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :if_modified_since (String) —

    Last modified condition, see <a href="#overview–conditional-get-requests–http-caching">Conditional GET requests / HTTP Caching</a> (optional)

  • :if_none_match (String) —

    ETag condition, see <a href="#overview–conditional-get-requests–http-caching">Conditional GET requests / HTTP Caching</a> (optional)

Returns:



20
21
22
23
 
# File 'lib/phrase/api/locale_downloads_api.rb', line 20

def locale_download_create(project_id, locale_id, locale_download_create_parameters, opts = {})
  data, _status_code, _headers = locale_download_create_with_http_info(project_id, locale_id, locale_download_create_parameters, opts)
  data
end

#locale_download_create_with_http_info(project_id, locale_id, locale_download_create_parameters, opts = {}) ⇒ Array<(Response<(LocaleDownload)>, Integer, Hash)>

Initiate async download of a locale Prepare a locale for download in a specific file format.

Parameters:

  • project_id (String) —

    Project ID

  • locale_id (String) —

    Locale ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :if_modified_since (String) —

    Last modified condition, see &lt;a href&#x3D;&quot;#overview–conditional-get-requests–http-caching&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)

  • :if_none_match (String) —

    ETag condition, see &lt;a href&#x3D;&quot;#overview–conditional-get-requests–http-caching&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)

Returns:

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

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



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/locale_downloads_api.rb', line 35

def locale_download_create_with_http_info(project_id, locale_id, locale_download_create_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocaleDownloadsApi.locale_download_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 LocaleDownloadsApi.locale_download_create"
  end
  # verify the required parameter 'locale_id' is set
  if @api_client.config.client_side_validation && locale_id.nil?
    fail ArgumentError, "Missing the required parameter 'locale_id' when calling LocaleDownloadsApi.locale_download_create"
  end
  # verify the required parameter 'locale_download_create_parameters' is set
  if @api_client.config.client_side_validation && locale_download_create_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'locale_download_create_parameters' when calling LocaleDownloadsApi.locale_download_create"
  end
  # resource path
  local_var_path = '/projects/{project_id}/locales/{locale_id}/downloads'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'locale_id' + '}', CGI.escape(locale_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?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(locale_download_create_parameters) 

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

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

#locale_download_show(project_id, locale_id, id, opts = {}) ⇒ LocaleDownload

Show status of an async locale download Show status of already started async locale download. If the download is finished, the download link will be returned.

Parameters:

  • project_id (String) —

    Project ID

  • locale_id (String) —

    Locale ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :if_modified_since (String) —

    Last modified condition, see &lt;a href&#x3D;&quot;#overview–conditional-get-requests–http-caching&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)

  • :if_none_match (String) —

    ETag condition, see &lt;a href&#x3D;&quot;#overview–conditional-get-requests–http-caching&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)

Returns:



106
107
108
109
 
# File 'lib/phrase/api/locale_downloads_api.rb', line 106

def locale_download_show(project_id, locale_id, id, opts = {})
  data, _status_code, _headers = locale_download_show_with_http_info(project_id, locale_id, id, opts)
  data
end

#locale_download_show_with_http_info(project_id, locale_id, id, opts = {}) ⇒ Array<(Response<(LocaleDownload)>, Integer, Hash)>

Show status of an async locale download Show status of already started async locale download. If the download is finished, the download link will be returned.

Parameters:

  • project_id (String) —

    Project ID

  • locale_id (String) —

    Locale ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :if_modified_since (String) —

    Last modified condition, see &lt;a href&#x3D;&quot;#overview–conditional-get-requests–http-caching&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)

  • :if_none_match (String) —

    ETag condition, see &lt;a href&#x3D;&quot;#overview–conditional-get-requests–http-caching&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)

Returns:

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

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



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
177
178
 
# File 'lib/phrase/api/locale_downloads_api.rb', line 121

def locale_download_show_with_http_info(project_id, locale_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocaleDownloadsApi.locale_download_show ...'
  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 LocaleDownloadsApi.locale_download_show"
  end
  # verify the required parameter 'locale_id' is set
  if @api_client.config.client_side_validation && locale_id.nil?
    fail ArgumentError, "Missing the required parameter 'locale_id' when calling LocaleDownloadsApi.locale_download_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 LocaleDownloadsApi.locale_download_show"
  end
  # resource path
  local_var_path = '/projects/{project_id}/locales/{locale_id}/downloads/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'locale_id' + '}', CGI.escape(locale_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?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

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

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