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). The following qualifiers are also supported in the search term: * `ids:key_id,...` for queries on a comma-separated list of ids * `name:key_name,...` for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes * `tags:tag_name,...` to filter for keys with certain comma-seperated list of tags * `uploads:upload_id,...` to filter for keys with certain comma-seperated list of uploads * `job:{true	false}` to filter for keys mentioned in an active job * `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')