KeysSearchParameters.md

Phrase::KeysSearchParameters

Properties

Name	Type	Description	Notes
branch	String	specify the branch to use	[optional]
sort	String	Sort by field. Can be one of: name, created_at, updated_at.	[optional]
order	String	Order direction. Can be one of: asc, desc.	[optional]
q	String	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 a comma-seperated list of 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 comma-seperated list of tags</li> <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li> <li><code>job:{true	false}</code> to filter for keys mentioned in an active job</li> <li><code>translated:{true
locale_id	String	Locale used to determine the translation state of a key when filtering for untranslated or translated keys.	[optional]

Code Sample

require 'Phrase'

instance = Phrase::KeysSearchParameters.new(branch: my-feature-branch,
                                 sort: updated_at,
                                 order: desc,
                                 q: mykey* translated:true,
                                 locale_id: abcd1234abcd1234abcd1234abcd1234)