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
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**description** | **String** | | [optional]
|
10
10
|
**name_hash** | **String** | | [optional]
|
11
11
|
**plural** | **Boolean** | | [optional]
|
12
|
+
**use_ordinal_rules** | **Boolean** | | [optional]
|
12
13
|
**tags** | **Array<String>** | | [optional]
|
13
14
|
**data_type** | **String** | | [optional]
|
14
15
|
**created_at** | **Time** | | [optional]
|
@@ -34,6 +35,7 @@ instance = Phrase::TranslationKeyDetails.new(id: null,
|
|
34
35
|
description: null,
|
35
36
|
name_hash: null,
|
36
37
|
plural: null,
|
38
|
+
use_ordinal_rules: null,
|
37
39
|
tags: null,
|
38
40
|
data_type: null,
|
39
41
|
created_at: null,
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
8
|
**content** | **String** | Translation content | [optional]
|
9
9
|
**plural_suffix** | **String** | Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized. | [optional]
|
10
|
-
**unverified** | **Boolean** | Indicates whether translation is unverified. Part of the
|
10
|
+
**unverified** | **Boolean** | Indicates whether translation is unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
|
11
11
|
**excluded** | **Boolean** | Indicates whether translation is excluded. | [optional]
|
12
12
|
**autotranslate** | **Boolean** | Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled. | [optional]
|
13
13
|
|
data/docs/TranslationsApi.md
CHANGED
@@ -643,7 +643,7 @@ opts = {
|
|
643
643
|
branch: 'my-feature-branch', # String | specify the branch to use
|
644
644
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
645
645
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
646
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards)
|
646
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | 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).
|
647
647
|
}
|
648
648
|
|
649
649
|
begin
|
@@ -668,7 +668,7 @@ Name | Type | Description | Notes
|
|
668
668
|
**branch** | **String**| specify the branch to use | [optional]
|
669
669
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
670
670
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
671
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards)
|
671
|
+
**q** | **String**| 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). | [optional]
|
672
672
|
|
673
673
|
### Return type
|
674
674
|
|
@@ -690,7 +690,7 @@ Response<([**Array<Translation>**](Translation.md))>
|
|
690
690
|
|
691
691
|
List translations by locale
|
692
692
|
|
693
|
-
List translations for a specific locale. If you want to download all translations for one locale we recommend to use the
|
693
|
+
List translations for a specific locale. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
694
694
|
|
695
695
|
### Example
|
696
696
|
|
@@ -718,7 +718,7 @@ opts = {
|
|
718
718
|
branch: 'my-feature-branch', # String | specify the branch to use
|
719
719
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
720
720
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
721
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards)
|
721
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | 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).
|
722
722
|
}
|
723
723
|
|
724
724
|
begin
|
@@ -743,7 +743,7 @@ Name | Type | Description | Notes
|
|
743
743
|
**branch** | **String**| specify the branch to use | [optional]
|
744
744
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
745
745
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
746
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards)
|
746
|
+
**q** | **String**| 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). | [optional]
|
747
747
|
|
748
748
|
### Return type
|
749
749
|
|
@@ -891,7 +891,7 @@ Response<([**AffectedCount**](AffectedCount.md))>
|
|
891
891
|
|
892
892
|
List all translations
|
893
893
|
|
894
|
-
List translations for the given project. If you want to download all translations for one locale we recommend to use the
|
894
|
+
List translations for the given project. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
895
895
|
|
896
896
|
### Example
|
897
897
|
|
@@ -913,14 +913,14 @@ api_instance = Phrase::TranslationsApi.new
|
|
913
913
|
project_id = 'project_id_example' # String | Project ID
|
914
914
|
opts = {
|
915
915
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
916
|
-
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see
|
917
|
-
if_none_match: 'if_none_match_example', # String | ETag condition, see
|
916
|
+
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
917
|
+
if_none_match: 'if_none_match_example', # String | ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
918
918
|
page: 1, # Integer | Page number
|
919
919
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
920
920
|
branch: 'my-feature-branch', # String | specify the branch to use
|
921
921
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
922
922
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
923
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards)
|
923
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | 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).
|
924
924
|
}
|
925
925
|
|
926
926
|
begin
|
@@ -939,14 +939,14 @@ Name | Type | Description | Notes
|
|
939
939
|
------------- | ------------- | ------------- | -------------
|
940
940
|
**project_id** | **String**| Project ID |
|
941
941
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
942
|
-
**if_modified_since** | **String**| Last modified condition, see
|
943
|
-
**if_none_match** | **String**| ETag condition, see
|
942
|
+
**if_modified_since** | **String**| Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
|
943
|
+
**if_none_match** | **String**| ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
|
944
944
|
**page** | **Integer**| Page number | [optional]
|
945
945
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
946
946
|
**branch** | **String**| specify the branch to use | [optional]
|
947
947
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
948
948
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
949
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards)
|
949
|
+
**q** | **String**| 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). | [optional]
|
950
950
|
|
951
951
|
### Return type
|
952
952
|
|
@@ -1031,7 +1031,7 @@ Response<([**AffectedCount**](AffectedCount.md))>
|
|
1031
1031
|
|
1032
1032
|
Search translations
|
1033
1033
|
|
1034
|
-
Search translations for the given project. Provides the same search interface as
|
1034
|
+
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.
|
1035
1035
|
|
1036
1036
|
### Example
|
1037
1037
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards)
|
8
|
+
**q** | **String** | 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
9
9
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
10
10
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
11
11
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards)
|
8
|
+
**q** | **String** | 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
9
9
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
10
10
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
11
11
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards)
|
8
|
+
**q** | **String** | 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
8
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
9
9
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
10
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards)
|
10
|
+
**q** | **String** | 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
11
11
|
|
12
12
|
## Code Sample
|
13
13
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards)
|
8
|
+
**q** | **String** | 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards)
|
8
|
+
**q** | **String** | 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
9
9
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
10
10
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
11
11
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
8
|
**locale_id** | **String** | specify the locale of the translations to be verified | [optional]
|
9
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards)
|
9
|
+
**q** | **String** | 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
10
10
|
|
11
11
|
## Code Sample
|
12
12
|
|
@@ -8,7 +8,7 @@ module Phrase
|
|
8
8
|
@api_client = api_client
|
9
9
|
end
|
10
10
|
# Compare branches
|
11
|
-
# Compare branch with main branch.
|
11
|
+
# Compare branch with main branch. *Note: Comparing a branch may take several minutes depending on the project size.*
|
12
12
|
# @param project_id [String] Project ID
|
13
13
|
# @param name [String] name
|
14
14
|
# @param [Hash] opts the optional parameters
|
@@ -20,7 +20,7 @@ module Phrase
|
|
20
20
|
end
|
21
21
|
|
22
22
|
# Compare branches
|
23
|
-
# Compare branch with main branch.
|
23
|
+
# Compare branch with main branch. *Note: Comparing a branch may take several minutes depending on the project size.*
|
24
24
|
# @param project_id [String] Project ID
|
25
25
|
# @param name [String] name
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -78,7 +78,7 @@ module Phrase
|
|
78
78
|
end
|
79
79
|
|
80
80
|
# Create a branch
|
81
|
-
# Create a new branch.
|
81
|
+
# Create a new branch. *Note: Creating a new branch may take several minutes depending on the project size.*
|
82
82
|
# @param project_id [String] Project ID
|
83
83
|
# @param branch_create_parameters [BranchCreateParameters]
|
84
84
|
# @param [Hash] opts the optional parameters
|
@@ -90,7 +90,7 @@ module Phrase
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Create a branch
|
93
|
-
# Create a new branch.
|
93
|
+
# Create a new branch. *Note: Creating a new branch may take several minutes depending on the project size.*
|
94
94
|
# @param project_id [String] Project ID
|
95
95
|
# @param branch_create_parameters [BranchCreateParameters]
|
96
96
|
# @param [Hash] opts the optional parameters
|
@@ -222,7 +222,7 @@ module Phrase
|
|
222
222
|
end
|
223
223
|
|
224
224
|
# Merge a branch
|
225
|
-
# Merge an existing branch.
|
225
|
+
# Merge an existing branch. *Note: Merging a branch may take several minutes depending on diff size.*
|
226
226
|
# @param project_id [String] Project ID
|
227
227
|
# @param name [String] name
|
228
228
|
# @param branch_merge_parameters [BranchMergeParameters]
|
@@ -235,7 +235,7 @@ module Phrase
|
|
235
235
|
end
|
236
236
|
|
237
237
|
# Merge a branch
|
238
|
-
# Merge an existing branch.
|
238
|
+
# Merge an existing branch. *Note: Merging a branch may take several minutes depending on diff size.*
|
239
239
|
# @param project_id [String] Project ID
|
240
240
|
# @param name [String] name
|
241
241
|
# @param branch_merge_parameters [BranchMergeParameters]
|
@@ -8,7 +8,7 @@ module Phrase
|
|
8
8
|
@api_client = api_client
|
9
9
|
end
|
10
10
|
# Create a new invitation
|
11
|
-
# Invite a person to an account. Developers and translators need
|
11
|
+
# Invite a person to an account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
|
12
12
|
# @param account_id [String] Account ID
|
13
13
|
# @param invitation_create_parameters [InvitationCreateParameters]
|
14
14
|
# @param [Hash] opts the optional parameters
|
@@ -20,7 +20,7 @@ module Phrase
|
|
20
20
|
end
|
21
21
|
|
22
22
|
# Create a new invitation
|
23
|
-
# Invite a person to an account. Developers and translators need
|
23
|
+
# Invite a person to an account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
|
24
24
|
# @param account_id [String] Account ID
|
25
25
|
# @param invitation_create_parameters [InvitationCreateParameters]
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -82,7 +82,7 @@ module Phrase
|
|
82
82
|
end
|
83
83
|
|
84
84
|
# Delete an invitation
|
85
|
-
# Delete an existing invitation (must not be accepted yet). Access token scope must include
|
85
|
+
# Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`.
|
86
86
|
# @param account_id [String] Account ID
|
87
87
|
# @param id [String] ID
|
88
88
|
# @param [Hash] opts the optional parameters
|
@@ -94,7 +94,7 @@ module Phrase
|
|
94
94
|
end
|
95
95
|
|
96
96
|
# Delete an invitation
|
97
|
-
# Delete an existing invitation (must not be accepted yet). Access token scope must include
|
97
|
+
# Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`.
|
98
98
|
# @param account_id [String] Account ID
|
99
99
|
# @param id [String] ID
|
100
100
|
# @param [Hash] opts the optional parameters
|
@@ -152,7 +152,7 @@ module Phrase
|
|
152
152
|
end
|
153
153
|
|
154
154
|
# Resend an invitation
|
155
|
-
# Resend the invitation email (must not be accepted yet). Access token scope must include
|
155
|
+
# Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`.
|
156
156
|
# @param account_id [String] Account ID
|
157
157
|
# @param id [String] ID
|
158
158
|
# @param [Hash] opts the optional parameters
|
@@ -164,7 +164,7 @@ module Phrase
|
|
164
164
|
end
|
165
165
|
|
166
166
|
# Resend an invitation
|
167
|
-
# Resend the invitation email (must not be accepted yet). Access token scope must include
|
167
|
+
# Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`.
|
168
168
|
# @param account_id [String] Account ID
|
169
169
|
# @param id [String] ID
|
170
170
|
# @param [Hash] opts the optional parameters
|
@@ -224,7 +224,7 @@ module Phrase
|
|
224
224
|
end
|
225
225
|
|
226
226
|
# Get a single invitation
|
227
|
-
# Get details on a single invitation. Access token scope must include
|
227
|
+
# Get details on a single invitation. Access token scope must include `team.manage`.
|
228
228
|
# @param account_id [String] Account ID
|
229
229
|
# @param id [String] ID
|
230
230
|
# @param [Hash] opts the optional parameters
|
@@ -236,7 +236,7 @@ module Phrase
|
|
236
236
|
end
|
237
237
|
|
238
238
|
# Get a single invitation
|
239
|
-
# Get details on a single invitation. Access token scope must include
|
239
|
+
# Get details on a single invitation. Access token scope must include `team.manage`.
|
240
240
|
# @param account_id [String] Account ID
|
241
241
|
# @param id [String] ID
|
242
242
|
# @param [Hash] opts the optional parameters
|
@@ -296,7 +296,7 @@ module Phrase
|
|
296
296
|
end
|
297
297
|
|
298
298
|
# Update an invitation
|
299
|
-
# Update an existing invitation (must not be accepted yet). The
|
299
|
+
# Update an existing invitation (must not be accepted yet). The `email` cannot be updated. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
|
300
300
|
# @param account_id [String] Account ID
|
301
301
|
# @param id [String] ID
|
302
302
|
# @param invitation_update_parameters [InvitationUpdateParameters]
|
@@ -309,7 +309,7 @@ module Phrase
|
|
309
309
|
end
|
310
310
|
|
311
311
|
# Update an invitation
|
312
|
-
# Update an existing invitation (must not be accepted yet). The
|
312
|
+
# Update an existing invitation (must not be accepted yet). The `email` cannot be updated. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
|
313
313
|
# @param account_id [String] Account ID
|
314
314
|
# @param id [String] ID
|
315
315
|
# @param invitation_update_parameters [InvitationUpdateParameters]
|
@@ -376,7 +376,7 @@ module Phrase
|
|
376
376
|
end
|
377
377
|
|
378
378
|
# Update a member's invitation access
|
379
|
-
# Update member's settings in the invitations. Access token scope must include
|
379
|
+
# Update member's settings in the invitations. Access token scope must include `team.manage`.
|
380
380
|
# @param project_id [String] Project ID
|
381
381
|
# @param id [String] ID
|
382
382
|
# @param invitation_update_settings_parameters [InvitationUpdateSettingsParameters]
|
@@ -389,7 +389,7 @@ module Phrase
|
|
389
389
|
end
|
390
390
|
|
391
391
|
# Update a member's invitation access
|
392
|
-
# Update member's settings in the invitations. Access token scope must include
|
392
|
+
# Update member's settings in the invitations. Access token scope must include `team.manage`.
|
393
393
|
# @param project_id [String] Project ID
|
394
394
|
# @param id [String] ID
|
395
395
|
# @param invitation_update_settings_parameters [InvitationUpdateSettingsParameters]
|
@@ -456,7 +456,7 @@ module Phrase
|
|
456
456
|
end
|
457
457
|
|
458
458
|
# List invitations
|
459
|
-
# List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include
|
459
|
+
# List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.
|
460
460
|
# @param account_id [String] Account ID
|
461
461
|
# @param [Hash] opts the optional parameters
|
462
462
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
@@ -469,7 +469,7 @@ module Phrase
|
|
469
469
|
end
|
470
470
|
|
471
471
|
# List invitations
|
472
|
-
# List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include
|
472
|
+
# List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.
|
473
473
|
# @param account_id [String] Account ID
|
474
474
|
# @param [Hash] opts the optional parameters
|
475
475
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|