lib/phrase/api/keys_api.rb in phrase-2.0.0 vs lib/phrase/api/keys_api.rb in phrase-2.1.0
- old
+ new
@@ -313,11 +313,11 @@
# Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
# @param project_id [String] Project ID
# @param [Hash] opts the optional parameters
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
# @option opts [String] :branch specify the branch to use
- # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
+ # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
# @return [AffectedResources]
def keys_delete_collection(project_id, opts = {})
data, _status_code, _headers = keys_delete_collection_with_http_info(project_id, opts)
data
@@ -327,11 +327,11 @@
# Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
# @param project_id [String] Project ID
# @param [Hash] opts the optional parameters
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
# @option opts [String] :branch specify the branch to use
- # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
+ # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
# @return [Array<(Response<(AffectedResources)>, Integer, Hash)>] Response<(AffectedResources)> data, response status code and response headers
def keys_delete_collection_with_http_info(project_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: KeysApi.keys_delete_collection ...'
@@ -382,21 +382,169 @@
end
response = ::Phrase::Response.new(data, headers)
return response, status_code, headers
end
+ # Exclude a locale on a collection of keys
+ # Exclude a locale on keys matching query. Same constraints as list.
+ # @param project_id [String] Project ID
+ # @param keys_exclude_parameters [KeysExcludeParameters]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [AffectedResources]
+ def keys_exclude(project_id, keys_exclude_parameters, opts = {})
+ data, _status_code, _headers = keys_exclude_with_http_info(project_id, keys_exclude_parameters, opts)
+ data
+ end
+
+ # Exclude a locale on a collection of keys
+ # Exclude a locale on keys matching query. Same constraints as list.
+ # @param project_id [String] Project ID
+ # @param keys_exclude_parameters [KeysExcludeParameters]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(AffectedResources)>, Integer, Hash)>] Response<(AffectedResources)> data, response status code and response headers
+ def keys_exclude_with_http_info(project_id, keys_exclude_parameters, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.keys_exclude ...'
+ 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 KeysApi.keys_exclude"
+ end
+ # verify the required parameter 'keys_exclude_parameters' is set
+ if @api_client.config.client_side_validation && keys_exclude_parameters.nil?
+ fail ArgumentError, "Missing the required parameter 'keys_exclude_parameters' when calling KeysApi.keys_exclude"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/exclude'.sub('{' + 'project_id' + '}', CGI.escape(project_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(keys_exclude_parameters)
+
+ # return_type
+ return_type = opts[:return_type] || 'AffectedResources'
+
+ # 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(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#keys_exclude\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Include a locale on a collection of keys
+ # Include a locale on keys matching query. Same constraints as list.
+ # @param project_id [String] Project ID
+ # @param keys_include_parameters [KeysIncludeParameters]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [AffectedResources]
+ def keys_include(project_id, keys_include_parameters, opts = {})
+ data, _status_code, _headers = keys_include_with_http_info(project_id, keys_include_parameters, opts)
+ data
+ end
+
+ # Include a locale on a collection of keys
+ # Include a locale on keys matching query. Same constraints as list.
+ # @param project_id [String] Project ID
+ # @param keys_include_parameters [KeysIncludeParameters]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(AffectedResources)>, Integer, Hash)>] Response<(AffectedResources)> data, response status code and response headers
+ def keys_include_with_http_info(project_id, keys_include_parameters, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.keys_include ...'
+ 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 KeysApi.keys_include"
+ end
+ # verify the required parameter 'keys_include_parameters' is set
+ if @api_client.config.client_side_validation && keys_include_parameters.nil?
+ fail ArgumentError, "Missing the required parameter 'keys_include_parameters' when calling KeysApi.keys_include"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/include'.sub('{' + 'project_id' + '}', CGI.escape(project_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(keys_include_parameters)
+
+ # return_type
+ return_type = opts[:return_type] || 'AffectedResources'
+
+ # 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(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#keys_include\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
# List keys
# List all keys for the given project. Alternatively you can POST requests to /search.
# @param project_id [String] Project ID
# @param [Hash] opts the optional parameters
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
# @option opts [Integer] :page Page number
# @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
# @option opts [String] :branch specify the branch to use
# @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
# @option opts [String] :order Order direction. Can be one of: asc, desc.
- # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
+ # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
# @return [Array<TranslationKey>]
def keys_list(project_id, opts = {})
data, _status_code, _headers = keys_list_with_http_info(project_id, opts)
data
@@ -410,10 +558,10 @@
# @option opts [Integer] :page Page number
# @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
# @option opts [String] :branch specify the branch to use
# @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
# @option opts [String] :order Order direction. Can be one of: asc, desc.
- # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
+ # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
# @return [Array<(Response<(Array<TranslationKey>)>, Integer, Hash)>] Response<(Array<TranslationKey>)> data, response status code and response headers
def keys_list_with_http_info(project_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: KeysApi.keys_list ...'