phrase 4.5.0 → 4.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +12 -3
- data/docs/BranchesApi.md +3 -3
- data/docs/DistributionCreateParameters.md +1 -1
- data/docs/DistributionUpdateParameters.md +1 -1
- data/docs/InvitationCreateParameters.md +2 -2
- data/docs/InvitationsApi.md +7 -7
- data/docs/JobAnnotation.md +23 -0
- data/docs/JobAnnotationShort.md +19 -0
- data/docs/JobAnnotationUpdateParameters.md +19 -0
- data/docs/JobAnnotationsApi.md +416 -0
- data/docs/JobDetails.md +3 -1
- data/docs/JobLocale.md +3 -1
- data/docs/JobLocalesApi.md +6 -2
- data/docs/JobsApi.md +8 -6
- data/docs/KeyCreateParameters.md +3 -1
- data/docs/KeyPreview.md +3 -1
- data/docs/KeyUpdateParameters.md +3 -1
- data/docs/KeysApi.md +4 -4
- data/docs/KeysExcludeParameters.md +1 -1
- data/docs/KeysIncludeParameters.md +1 -1
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/KeysTagParameters.md +1 -1
- data/docs/KeysUntagParameters.md +1 -1
- data/docs/Locale.md +2 -0
- data/docs/LocaleCreateParameters.md +3 -3
- data/docs/LocaleDetails.md +2 -0
- data/docs/LocaleDownloadCreateParameters.md +7 -5
- data/docs/LocaleDownloadsApi.md +8 -8
- data/docs/LocaleUpdateParameters.md +3 -3
- data/docs/LocalesApi.md +17 -15
- data/docs/MemberUpdateParameters.md +1 -1
- data/docs/MembersApi.md +5 -5
- data/docs/OrdersApi.md +1 -1
- data/docs/ProjectCreateParameters.md +5 -5
- data/docs/ProjectUpdateParameters.md +6 -6
- data/docs/ReleaseTriggersApi.md +1 -1
- data/docs/ScreenshotMarkerCreateParameters.md +1 -1
- data/docs/ScreenshotMarkerUpdateParameters.md +1 -1
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/docs/SearchApi.md +1 -1
- data/docs/TagsApi.md +2 -0
- data/docs/TranslationCreateParameters.md +1 -1
- data/docs/TranslationKey.md +2 -0
- data/docs/TranslationKeyDetails.md +2 -0
- data/docs/TranslationUpdateParameters.md +1 -1
- data/docs/TranslationsApi.md +13 -13
- data/docs/TranslationsExcludeParameters.md +1 -1
- data/docs/TranslationsIncludeParameters.md +1 -1
- data/docs/TranslationsReviewParameters.md +1 -1
- data/docs/TranslationsSearchParameters.md +1 -1
- data/docs/TranslationsUnreviewParameters.md +1 -1
- data/docs/TranslationsUnverifyParameters.md +1 -1
- data/docs/TranslationsVerifyParameters.md +1 -1
- data/lib/phrase/api/branches_api.rb +6 -6
- data/lib/phrase/api/invitations_api.rb +14 -14
- data/lib/phrase/api/job_annotations_api.rb +508 -0
- data/lib/phrase/api/job_locales_api.rb +6 -0
- data/lib/phrase/api/jobs_api.rb +9 -6
- data/lib/phrase/api/keys_api.rb +4 -4
- data/lib/phrase/api/locale_downloads_api.rb +8 -8
- data/lib/phrase/api/locales_api.rb +17 -14
- data/lib/phrase/api/members_api.rb +10 -10
- data/lib/phrase/api/orders_api.rb +2 -2
- data/lib/phrase/api/release_triggers_api.rb +2 -2
- data/lib/phrase/api/search_api.rb +2 -2
- data/lib/phrase/api/tags_api.rb +3 -0
- data/lib/phrase/api/translations_api.rb +16 -16
- data/lib/phrase/models/distribution_create_parameters.rb +1 -1
- data/lib/phrase/models/distribution_update_parameters.rb +1 -1
- data/lib/phrase/models/invitation_create_parameters.rb +2 -2
- data/lib/phrase/models/job_annotation.rb +233 -0
- data/lib/phrase/models/job_annotation_short.rb +215 -0
- data/lib/phrase/models/job_annotation_update_parameters.rb +207 -0
- data/lib/phrase/models/job_details.rb +15 -4
- data/lib/phrase/models/job_locale.rb +15 -4
- data/lib/phrase/models/key_create_parameters.rb +11 -1
- data/lib/phrase/models/key_preview.rb +13 -4
- data/lib/phrase/models/key_update_parameters.rb +11 -1
- data/lib/phrase/models/keys_exclude_parameters.rb +1 -1
- data/lib/phrase/models/keys_include_parameters.rb +1 -1
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/keys_tag_parameters.rb +1 -1
- data/lib/phrase/models/keys_untag_parameters.rb +1 -1
- data/lib/phrase/models/locale.rb +12 -1
- data/lib/phrase/models/locale_create_parameters.rb +3 -3
- data/lib/phrase/models/locale_details.rb +12 -1
- data/lib/phrase/models/locale_download_create_parameters.rb +18 -8
- data/lib/phrase/models/locale_update_parameters.rb +3 -3
- data/lib/phrase/models/member_update_parameters.rb +1 -1
- data/lib/phrase/models/project_create_parameters.rb +4 -4
- data/lib/phrase/models/project_update_parameters.rb +5 -5
- data/lib/phrase/models/screenshot_marker_create_parameters.rb +1 -1
- data/lib/phrase/models/screenshot_marker_update_parameters.rb +1 -1
- data/lib/phrase/models/translation_create_parameters.rb +1 -1
- data/lib/phrase/models/translation_key.rb +10 -1
- data/lib/phrase/models/translation_key_details.rb +10 -1
- data/lib/phrase/models/translation_update_parameters.rb +1 -1
- data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
- data/lib/phrase/models/translations_include_parameters.rb +1 -1
- data/lib/phrase/models/translations_review_parameters.rb +1 -1
- data/lib/phrase/models/translations_search_parameters.rb +1 -1
- data/lib/phrase/models/translations_unreview_parameters.rb +1 -1
- data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
- data/lib/phrase/models/translations_verify_parameters.rb +1 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +4 -0
- data/spec/api/branches_api_spec.rb +3 -3
- data/spec/api/invitations_api_spec.rb +7 -7
- data/spec/api/job_annotations_api_spec.rb +120 -0
- data/spec/api/job_locales_api_spec.rb +2 -0
- data/spec/api/jobs_api_spec.rb +4 -3
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/locale_downloads_api_spec.rb +4 -4
- data/spec/api/members_api_spec.rb +5 -5
- data/spec/api/orders_api_spec.rb +1 -1
- data/spec/api/release_triggers_api_spec.rb +1 -1
- data/spec/api/search_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +1 -0
- data/spec/api/translations_api_spec.rb +8 -8
- data/spec/models/job_annotation_short_spec.rb +35 -0
- data/spec/models/job_annotation_spec.rb +47 -0
- data/spec/models/job_annotation_update_parameters_spec.rb +35 -0
- data/spec/models/job_details_spec.rb +6 -0
- data/spec/models/job_locale_spec.rb +6 -0
- data/spec/models/key_create_parameters_spec.rb +6 -0
- data/spec/models/key_preview_spec.rb +6 -0
- data/spec/models/key_update_parameters_spec.rb +6 -0
- data/spec/models/locale_details_spec.rb +6 -0
- data/spec/models/locale_download_create_parameters_spec.rb +6 -0
- data/spec/models/locale_spec.rb +6 -0
- data/spec/models/translation_key_details_spec.rb +6 -0
- data/spec/models/translation_key_spec.rb +6 -0
- metadata +247 -231
data/lib/phrase/api/keys_api.rb
CHANGED
@@ -315,7 +315,7 @@ module Phrase
|
|
315
315
|
# @param [Hash] opts the optional parameters
|
316
316
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
317
317
|
# @option opts [String] :branch specify the branch to use
|
318
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards)
|
318
|
+
# @option opts [String] :q 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 exact key names - spaces, commas, and colons need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples).
|
319
319
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
320
320
|
# @return [AffectedResources]
|
321
321
|
def keys_delete_collection(project_id, opts = {})
|
@@ -329,7 +329,7 @@ module Phrase
|
|
329
329
|
# @param [Hash] opts the optional parameters
|
330
330
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
331
331
|
# @option opts [String] :branch specify the branch to use
|
332
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards)
|
332
|
+
# @option opts [String] :q 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 exact key names - spaces, commas, and colons need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples).
|
333
333
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
334
334
|
# @return [Array<(Response<(AffectedResources)>, Integer, Hash)>] Response<(AffectedResources)> data, response status code and response headers
|
335
335
|
def keys_delete_collection_with_http_info(project_id, opts = {})
|
@@ -542,7 +542,7 @@ module Phrase
|
|
542
542
|
# @option opts [String] :branch specify the branch to use
|
543
543
|
# @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
|
544
544
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
545
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards)
|
545
|
+
# @option opts [String] :q 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 exact key names - spaces, commas, and colons need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples).
|
546
546
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
547
547
|
# @return [Array<TranslationKey>]
|
548
548
|
def keys_list(project_id, opts = {})
|
@@ -560,7 +560,7 @@ module Phrase
|
|
560
560
|
# @option opts [String] :branch specify the branch to use
|
561
561
|
# @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
|
562
562
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
563
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards)
|
563
|
+
# @option opts [String] :q 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 exact key names - spaces, commas, and colons need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples).
|
564
564
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
565
565
|
# @return [Array<(Response<(Array<TranslationKey>)>, Integer, Hash)>] Response<(Array<TranslationKey>)> data, response status code and response headers
|
566
566
|
def keys_list_with_http_info(project_id, opts = {})
|
@@ -14,8 +14,8 @@ module Phrase
|
|
14
14
|
# @param locale_download_create_parameters [LocaleDownloadCreateParameters]
|
15
15
|
# @param [Hash] opts the optional parameters
|
16
16
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
17
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
18
|
-
# @option opts [String] :if_none_match ETag condition, see
|
17
|
+
# @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
18
|
+
# @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
19
19
|
# @return [LocaleDownload]
|
20
20
|
def locale_download_create(project_id, locale_id, locale_download_create_parameters, opts = {})
|
21
21
|
data, _status_code, _headers = locale_download_create_with_http_info(project_id, locale_id, locale_download_create_parameters, opts)
|
@@ -29,8 +29,8 @@ module Phrase
|
|
29
29
|
# @param locale_download_create_parameters [LocaleDownloadCreateParameters]
|
30
30
|
# @param [Hash] opts the optional parameters
|
31
31
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
32
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
33
|
-
# @option opts [String] :if_none_match ETag condition, see
|
32
|
+
# @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
33
|
+
# @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
34
34
|
# @return [Array<(Response<(LocaleDownload)>, Integer, Hash)>] Response<(LocaleDownload)> data, response status code and response headers
|
35
35
|
def locale_download_create_with_http_info(project_id, locale_id, locale_download_create_parameters, opts = {})
|
36
36
|
if @api_client.config.debugging
|
@@ -100,8 +100,8 @@ module Phrase
|
|
100
100
|
# @param id [String] ID
|
101
101
|
# @param [Hash] opts the optional parameters
|
102
102
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
103
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
104
|
-
# @option opts [String] :if_none_match ETag condition, see
|
103
|
+
# @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
104
|
+
# @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
105
105
|
# @return [LocaleDownload]
|
106
106
|
def locale_download_show(project_id, locale_id, id, opts = {})
|
107
107
|
data, _status_code, _headers = locale_download_show_with_http_info(project_id, locale_id, id, opts)
|
@@ -115,8 +115,8 @@ module Phrase
|
|
115
115
|
# @param id [String] ID
|
116
116
|
# @param [Hash] opts the optional parameters
|
117
117
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
118
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
119
|
-
# @option opts [String] :if_none_match ETag condition, see
|
118
|
+
# @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
119
|
+
# @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
120
120
|
# @return [Array<(Response<(LocaleDownload)>, Integer, Hash)>] Response<(LocaleDownload)> data, response status code and response headers
|
121
121
|
def locale_download_show_with_http_info(project_id, locale_id, id, opts = {})
|
122
122
|
if @api_client.config.debugging
|
@@ -232,10 +232,10 @@ module Phrase
|
|
232
232
|
# @param id [String] Locale ID or locale name
|
233
233
|
# @param [Hash] opts the optional parameters
|
234
234
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
235
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
236
|
-
# @option opts [String] :if_none_match ETag condition, see
|
235
|
+
# @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
236
|
+
# @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
237
237
|
# @option opts [String] :branch specify the branch to use
|
238
|
-
# @option opts [String] :file_format File format name. See the
|
238
|
+
# @option opts [String] :file_format File format name. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for all supported file formats.
|
239
239
|
# @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
|
240
240
|
# @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
|
241
241
|
# @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
|
@@ -243,17 +243,18 @@ module Phrase
|
|
243
243
|
# @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
|
244
244
|
# @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
|
245
245
|
# @option opts [Boolean] :convert_emoji This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
|
246
|
-
# @option opts [Object] :format_options Additional formatting and render options. See the
|
246
|
+
# @option opts [Object] :format_options Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar`
|
247
247
|
# @option opts [String] :encoding Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
|
248
|
-
# @option opts [Boolean] :skip_unverified_translations Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with
|
248
|
+
# @option opts [Boolean] :skip_unverified_translations Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with `include_unverified_translations`.
|
249
249
|
# @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
|
250
250
|
# @option opts [Boolean] :use_last_reviewed_version If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
|
251
|
-
# @option opts [String] :fallback_locale_id If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to
|
252
|
-
# @option opts [String] :source_locale_id Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a
|
251
|
+
# @option opts [String] :fallback_locale_id If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to `true`.
|
252
|
+
# @option opts [String] :source_locale_id Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job.
|
253
253
|
# @option opts [String] :translation_key_prefix Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed.
|
254
254
|
# @option opts [Boolean] :filter_by_prefix Only download translation keys containing the specified prefix, and remove the prefix from the generated file.
|
255
255
|
# @option opts [Object] :custom_metadata_filters Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.
|
256
256
|
# @option opts [Array<String>] :locale_ids Locale IDs or locale names
|
257
|
+
# @option opts [String] :updated_since Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).
|
257
258
|
# @return [File]
|
258
259
|
def locale_download(project_id, id, opts = {})
|
259
260
|
data, _status_code, _headers = locale_download_with_http_info(project_id, id, opts)
|
@@ -266,10 +267,10 @@ module Phrase
|
|
266
267
|
# @param id [String] Locale ID or locale name
|
267
268
|
# @param [Hash] opts the optional parameters
|
268
269
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
269
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
270
|
-
# @option opts [String] :if_none_match ETag condition, see
|
270
|
+
# @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
271
|
+
# @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
271
272
|
# @option opts [String] :branch specify the branch to use
|
272
|
-
# @option opts [String] :file_format File format name. See the
|
273
|
+
# @option opts [String] :file_format File format name. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for all supported file formats.
|
273
274
|
# @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
|
274
275
|
# @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
|
275
276
|
# @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
|
@@ -277,17 +278,18 @@ module Phrase
|
|
277
278
|
# @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
|
278
279
|
# @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
|
279
280
|
# @option opts [Boolean] :convert_emoji This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
|
280
|
-
# @option opts [Object] :format_options Additional formatting and render options. See the
|
281
|
+
# @option opts [Object] :format_options Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar`
|
281
282
|
# @option opts [String] :encoding Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
|
282
|
-
# @option opts [Boolean] :skip_unverified_translations Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with
|
283
|
+
# @option opts [Boolean] :skip_unverified_translations Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with `include_unverified_translations`.
|
283
284
|
# @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
|
284
285
|
# @option opts [Boolean] :use_last_reviewed_version If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
|
285
|
-
# @option opts [String] :fallback_locale_id If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to
|
286
|
-
# @option opts [String] :source_locale_id Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a
|
286
|
+
# @option opts [String] :fallback_locale_id If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to `true`.
|
287
|
+
# @option opts [String] :source_locale_id Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job.
|
287
288
|
# @option opts [String] :translation_key_prefix Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed.
|
288
289
|
# @option opts [Boolean] :filter_by_prefix Only download translation keys containing the specified prefix, and remove the prefix from the generated file.
|
289
290
|
# @option opts [Object] :custom_metadata_filters Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.
|
290
291
|
# @option opts [Array<String>] :locale_ids Locale IDs or locale names
|
292
|
+
# @option opts [String] :updated_since Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).
|
291
293
|
# @return [Array<(Response<(File)>, Integer, Hash)>] Response<(File)> data, response status code and response headers
|
292
294
|
def locale_download_with_http_info(project_id, id, opts = {})
|
293
295
|
if @api_client.config.debugging
|
@@ -326,6 +328,7 @@ module Phrase
|
|
326
328
|
query_params[:'filter_by_prefix'] = opts[:'filter_by_prefix'] if !opts[:'filter_by_prefix'].nil?
|
327
329
|
query_params[:'custom_metadata_filters'] = opts[:'custom_metadata_filters'] if !opts[:'custom_metadata_filters'].nil?
|
328
330
|
query_params[:'locale_ids'] = @api_client.build_collection_param(opts[:'locale_ids'], :multi) if !opts[:'locale_ids'].nil?
|
331
|
+
query_params[:'updated_since'] = opts[:'updated_since'] if !opts[:'updated_since'].nil?
|
329
332
|
|
330
333
|
# header parameters
|
331
334
|
header_params = opts[:header_params] || {}
|
@@ -8,7 +8,7 @@ module Phrase
|
|
8
8
|
@api_client = api_client
|
9
9
|
end
|
10
10
|
# Remove a user from the account
|
11
|
-
# Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include
|
11
|
+
# Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include `team.manage`.
|
12
12
|
# @param account_id [String] Account ID
|
13
13
|
# @param id [String] ID
|
14
14
|
# @param [Hash] opts the optional parameters
|
@@ -20,7 +20,7 @@ module Phrase
|
|
20
20
|
end
|
21
21
|
|
22
22
|
# Remove a user from the account
|
23
|
-
# Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include
|
23
|
+
# Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include `team.manage`.
|
24
24
|
# @param account_id [String] Account ID
|
25
25
|
# @param id [String] ID
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -78,7 +78,7 @@ module Phrase
|
|
78
78
|
end
|
79
79
|
|
80
80
|
# Get single member
|
81
|
-
# Get details on a single user in the account. Access token scope must include
|
81
|
+
# Get details on a single user in the account. Access token scope must include `team.manage`.
|
82
82
|
# @param account_id [String] Account ID
|
83
83
|
# @param id [String] ID
|
84
84
|
# @param [Hash] opts the optional parameters
|
@@ -90,7 +90,7 @@ module Phrase
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Get single member
|
93
|
-
# Get details on a single user in the account. Access token scope must include
|
93
|
+
# Get details on a single user in the account. Access token scope must include `team.manage`.
|
94
94
|
# @param account_id [String] Account ID
|
95
95
|
# @param id [String] ID
|
96
96
|
# @param [Hash] opts the optional parameters
|
@@ -150,7 +150,7 @@ module Phrase
|
|
150
150
|
end
|
151
151
|
|
152
152
|
# Update a member
|
153
|
-
# Update user permissions in the account. Developers and translators need
|
153
|
+
# Update user permissions in the account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
|
154
154
|
# @param account_id [String] Account ID
|
155
155
|
# @param id [String] ID
|
156
156
|
# @param member_update_parameters [MemberUpdateParameters]
|
@@ -163,7 +163,7 @@ module Phrase
|
|
163
163
|
end
|
164
164
|
|
165
165
|
# Update a member
|
166
|
-
# Update user permissions in the account. Developers and translators need
|
166
|
+
# Update user permissions in the account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
|
167
167
|
# @param account_id [String] Account ID
|
168
168
|
# @param id [String] ID
|
169
169
|
# @param member_update_parameters [MemberUpdateParameters]
|
@@ -230,7 +230,7 @@ module Phrase
|
|
230
230
|
end
|
231
231
|
|
232
232
|
# Update a member's project settings
|
233
|
-
# Update user settings in the project. Access token scope must include
|
233
|
+
# Update user settings in the project. Access token scope must include `team.manage`.
|
234
234
|
# @param project_id [String] Project ID
|
235
235
|
# @param id [String] ID
|
236
236
|
# @param member_update_settings_parameters [MemberUpdateSettingsParameters]
|
@@ -243,7 +243,7 @@ module Phrase
|
|
243
243
|
end
|
244
244
|
|
245
245
|
# Update a member's project settings
|
246
|
-
# Update user settings in the project. Access token scope must include
|
246
|
+
# Update user settings in the project. Access token scope must include `team.manage`.
|
247
247
|
# @param project_id [String] Project ID
|
248
248
|
# @param id [String] ID
|
249
249
|
# @param member_update_settings_parameters [MemberUpdateSettingsParameters]
|
@@ -310,7 +310,7 @@ module Phrase
|
|
310
310
|
end
|
311
311
|
|
312
312
|
# List members
|
313
|
-
# Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include
|
313
|
+
# Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.
|
314
314
|
# @param account_id [String] Account ID
|
315
315
|
# @param [Hash] opts the optional parameters
|
316
316
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
@@ -323,7 +323,7 @@ module Phrase
|
|
323
323
|
end
|
324
324
|
|
325
325
|
# List members
|
326
|
-
# Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include
|
326
|
+
# Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.
|
327
327
|
# @param account_id [String] Account ID
|
328
328
|
# @param [Hash] opts the optional parameters
|
329
329
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
@@ -88,7 +88,7 @@ module Phrase
|
|
88
88
|
end
|
89
89
|
|
90
90
|
# Create a new order
|
91
|
-
# Create a new order. Access token scope must include
|
91
|
+
# Create a new order. Access token scope must include `orders.create`.
|
92
92
|
# @param project_id [String] Project ID
|
93
93
|
# @param order_create_parameters [OrderCreateParameters]
|
94
94
|
# @param [Hash] opts the optional parameters
|
@@ -100,7 +100,7 @@ module Phrase
|
|
100
100
|
end
|
101
101
|
|
102
102
|
# Create a new order
|
103
|
-
# Create a new order. Access token scope must include
|
103
|
+
# Create a new order. Access token scope must include `orders.create`.
|
104
104
|
# @param project_id [String] Project ID
|
105
105
|
# @param order_create_parameters [OrderCreateParameters]
|
106
106
|
# @param [Hash] opts the optional parameters
|
@@ -164,7 +164,7 @@ module Phrase
|
|
164
164
|
end
|
165
165
|
|
166
166
|
# List release triggers
|
167
|
-
# List all release triggers for the given distribution
|
167
|
+
# List all release triggers for the given distribution. Note: Currently only one release trigger can exist per distribution.
|
168
168
|
# @param account_id [String] Account ID
|
169
169
|
# @param distribution_id [String] Distribution ID
|
170
170
|
# @param [Hash] opts the optional parameters
|
@@ -176,7 +176,7 @@ module Phrase
|
|
176
176
|
end
|
177
177
|
|
178
178
|
# List release triggers
|
179
|
-
# List all release triggers for the given distribution
|
179
|
+
# List all release triggers for the given distribution. Note: Currently only one release trigger can exist per distribution.
|
180
180
|
# @param account_id [String] Account ID
|
181
181
|
# @param distribution_id [String] Distribution ID
|
182
182
|
# @param [Hash] opts the optional parameters
|
@@ -8,7 +8,7 @@ module Phrase
|
|
8
8
|
@api_client = api_client
|
9
9
|
end
|
10
10
|
# Search across projects
|
11
|
-
# Search for keys and translations in all account projects
|
11
|
+
# Search for keys and translations in all account projects *Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.*
|
12
12
|
# @param account_id [String] Account ID
|
13
13
|
# @param search_in_account_parameters [SearchInAccountParameters]
|
14
14
|
# @param [Hash] opts the optional parameters
|
@@ -20,7 +20,7 @@ module Phrase
|
|
20
20
|
end
|
21
21
|
|
22
22
|
# Search across projects
|
23
|
-
# Search for keys and translations in all account projects
|
23
|
+
# Search for keys and translations in all account projects *Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.*
|
24
24
|
# @param account_id [String] Account ID
|
25
25
|
# @param search_in_account_parameters [SearchInAccountParameters]
|
26
26
|
# @param [Hash] opts the optional parameters
|
data/lib/phrase/api/tags_api.rb
CHANGED
@@ -160,6 +160,7 @@ module Phrase
|
|
160
160
|
# @param name [String] name
|
161
161
|
# @param [Hash] opts the optional parameters
|
162
162
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
163
|
+
# @option opts [Boolean] :omit_statistics omit statistics in the response
|
163
164
|
# @option opts [String] :branch specify the branch to use
|
164
165
|
# @return [TagWithStats]
|
165
166
|
def tag_show(project_id, name, opts = {})
|
@@ -173,6 +174,7 @@ module Phrase
|
|
173
174
|
# @param name [String] name
|
174
175
|
# @param [Hash] opts the optional parameters
|
175
176
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
177
|
+
# @option opts [Boolean] :omit_statistics omit statistics in the response
|
176
178
|
# @option opts [String] :branch specify the branch to use
|
177
179
|
# @return [Array<(Response<(TagWithStats)>, Integer, Hash)>] Response<(TagWithStats)> data, response status code and response headers
|
178
180
|
def tag_show_with_http_info(project_id, name, opts = {})
|
@@ -192,6 +194,7 @@ module Phrase
|
|
192
194
|
|
193
195
|
# query parameters
|
194
196
|
query_params = opts[:query_params] || {}
|
197
|
+
query_params[:'omit_statistics'] = opts[:'omit_statistics'] if !opts[:'omit_statistics'].nil?
|
195
198
|
query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
|
196
199
|
|
197
200
|
# header parameters
|
@@ -727,7 +727,7 @@ module Phrase
|
|
727
727
|
# @option opts [String] :branch specify the branch to use
|
728
728
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
729
729
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
730
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards)
|
730
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards). The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `unverified:{true|false}` for verification status * `tags:XYZ` for tags on the translation * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
731
731
|
# @return [Array<Translation>]
|
732
732
|
def translations_by_key(project_id, key_id, opts = {})
|
733
733
|
data, _status_code, _headers = translations_by_key_with_http_info(project_id, key_id, opts)
|
@@ -745,7 +745,7 @@ module Phrase
|
|
745
745
|
# @option opts [String] :branch specify the branch to use
|
746
746
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
747
747
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
748
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards)
|
748
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards). The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `unverified:{true|false}` for verification status * `tags:XYZ` for tags on the translation * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
749
749
|
# @return [Array<(Response<(Array<Translation>)>, Integer, Hash)>] Response<(Array<Translation>)> data, response status code and response headers
|
750
750
|
def translations_by_key_with_http_info(project_id, key_id, opts = {})
|
751
751
|
if @api_client.config.debugging
|
@@ -807,7 +807,7 @@ module Phrase
|
|
807
807
|
end
|
808
808
|
|
809
809
|
# List translations by locale
|
810
|
-
# List translations for a specific locale. If you want to download all translations for one locale we recommend to use the
|
810
|
+
# List translations for a specific locale. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
811
811
|
# @param project_id [String] Project ID
|
812
812
|
# @param locale_id [String] Locale ID
|
813
813
|
# @param [Hash] opts the optional parameters
|
@@ -817,7 +817,7 @@ module Phrase
|
|
817
817
|
# @option opts [String] :branch specify the branch to use
|
818
818
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
819
819
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
820
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards)
|
820
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: - `id:translation_id,...` for queries on a comma-separated list of ids - `unverified:{true|false}` for verification status - `tags:XYZ` for tags on the translation - `excluded:{true|false}` for exclusion status - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
821
821
|
# @return [Array<Translation>]
|
822
822
|
def translations_by_locale(project_id, locale_id, opts = {})
|
823
823
|
data, _status_code, _headers = translations_by_locale_with_http_info(project_id, locale_id, opts)
|
@@ -825,7 +825,7 @@ module Phrase
|
|
825
825
|
end
|
826
826
|
|
827
827
|
# List translations by locale
|
828
|
-
# List translations for a specific locale. If you want to download all translations for one locale we recommend to use the
|
828
|
+
# List translations for a specific locale. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
829
829
|
# @param project_id [String] Project ID
|
830
830
|
# @param locale_id [String] Locale ID
|
831
831
|
# @param [Hash] opts the optional parameters
|
@@ -835,7 +835,7 @@ module Phrase
|
|
835
835
|
# @option opts [String] :branch specify the branch to use
|
836
836
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
837
837
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
838
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards)
|
838
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: - `id:translation_id,...` for queries on a comma-separated list of ids - `unverified:{true|false}` for verification status - `tags:XYZ` for tags on the translation - `excluded:{true|false}` for exclusion status - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
839
839
|
# @return [Array<(Response<(Array<Translation>)>, Integer, Hash)>] Response<(Array<Translation>)> data, response status code and response headers
|
840
840
|
def translations_by_locale_with_http_info(project_id, locale_id, opts = {})
|
841
841
|
if @api_client.config.debugging
|
@@ -1045,18 +1045,18 @@ module Phrase
|
|
1045
1045
|
end
|
1046
1046
|
|
1047
1047
|
# List all translations
|
1048
|
-
# List translations for the given project. If you want to download all translations for one locale we recommend to use the
|
1048
|
+
# List translations for the given project. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
1049
1049
|
# @param project_id [String] Project ID
|
1050
1050
|
# @param [Hash] opts the optional parameters
|
1051
1051
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
1052
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
1053
|
-
# @option opts [String] :if_none_match ETag condition, see
|
1052
|
+
# @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
1053
|
+
# @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
1054
1054
|
# @option opts [Integer] :page Page number
|
1055
1055
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
1056
1056
|
# @option opts [String] :branch specify the branch to use
|
1057
1057
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
1058
1058
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
1059
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards)
|
1059
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples).
|
1060
1060
|
# @return [Array<Translation>]
|
1061
1061
|
def translations_list(project_id, opts = {})
|
1062
1062
|
data, _status_code, _headers = translations_list_with_http_info(project_id, opts)
|
@@ -1064,18 +1064,18 @@ module Phrase
|
|
1064
1064
|
end
|
1065
1065
|
|
1066
1066
|
# List all translations
|
1067
|
-
# List translations for the given project. If you want to download all translations for one locale we recommend to use the
|
1067
|
+
# List translations for the given project. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
1068
1068
|
# @param project_id [String] Project ID
|
1069
1069
|
# @param [Hash] opts the optional parameters
|
1070
1070
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
1071
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
1072
|
-
# @option opts [String] :if_none_match ETag condition, see
|
1071
|
+
# @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
1072
|
+
# @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
1073
1073
|
# @option opts [Integer] :page Page number
|
1074
1074
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
1075
1075
|
# @option opts [String] :branch specify the branch to use
|
1076
1076
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
1077
1077
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
1078
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards)
|
1078
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples).
|
1079
1079
|
# @return [Array<(Response<(Array<Translation>)>, Integer, Hash)>] Response<(Array<Translation>)> data, response status code and response headers
|
1080
1080
|
def translations_list_with_http_info(project_id, opts = {})
|
1081
1081
|
if @api_client.config.debugging
|
@@ -1209,7 +1209,7 @@ module Phrase
|
|
1209
1209
|
end
|
1210
1210
|
|
1211
1211
|
# Search translations
|
1212
|
-
# Search translations for the given project. Provides the same search interface as
|
1212
|
+
# Search translations for the given project. Provides the same search interface as `translations#index` but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
1213
1213
|
# @param project_id [String] Project ID
|
1214
1214
|
# @param translations_search_parameters [TranslationsSearchParameters]
|
1215
1215
|
# @param [Hash] opts the optional parameters
|
@@ -1223,7 +1223,7 @@ module Phrase
|
|
1223
1223
|
end
|
1224
1224
|
|
1225
1225
|
# Search translations
|
1226
|
-
# Search translations for the given project. Provides the same search interface as
|
1226
|
+
# Search translations for the given project. Provides the same search interface as `translations#index` but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
1227
1227
|
# @param project_id [String] Project ID
|
1228
1228
|
# @param translations_search_parameters [TranslationsSearchParameters]
|
1229
1229
|
# @param [Hash] opts the optional parameters
|
@@ -14,7 +14,7 @@ module Phrase
|
|
14
14
|
# List of locale ids that will be part of distribution releases
|
15
15
|
attr_accessor :locale_ids
|
16
16
|
|
17
|
-
# Additional formatting and render options. Only
|
17
|
+
# Additional formatting and render options. Only `enclose_in_cdata` is available for platform `android`.
|
18
18
|
attr_accessor :format_options
|
19
19
|
|
20
20
|
# Use fallback locale if there is no translation in the current locale.
|
@@ -14,7 +14,7 @@ module Phrase
|
|
14
14
|
# List of locale ids that will be part of distribution releases
|
15
15
|
attr_accessor :locale_ids
|
16
16
|
|
17
|
-
# Additional formatting and render options. Only
|
17
|
+
# Additional formatting and render options. Only `enclose_in_cdata` is available for platform `android`.
|
18
18
|
attr_accessor :format_options
|
19
19
|
|
20
20
|
# Use fallback locale if there is no translation in the current locale.
|
@@ -2,7 +2,7 @@ require 'date'
|
|
2
2
|
|
3
3
|
module Phrase
|
4
4
|
class InvitationCreateParameters
|
5
|
-
# The email of the invited user. The
|
5
|
+
# The email of the invited user. The `email` can not be updated once created. Create a new invitation for each unique email.
|
6
6
|
attr_accessor :email
|
7
7
|
|
8
8
|
# Invitiation role, can be any of Manager, Developer, Translator.
|
@@ -23,7 +23,7 @@ module Phrase
|
|
23
23
|
# List of default locales for the user.
|
24
24
|
attr_accessor :default_locale_codes
|
25
25
|
|
26
|
-
# Additional permissions depending on invitation role. Available permissions are
|
26
|
+
# Additional permissions depending on invitation role. Available permissions are `create_upload` and `review_translations`
|
27
27
|
attr_accessor :permissions
|
28
28
|
|
29
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|