phrase 4.4.0 → 4.7.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 +30 -0
- data/README.md +7 -5
- data/docs/BranchesApi.md +3 -3
- data/docs/CommentRepliesApi.md +3 -5
- data/docs/CommentsApi.md +3 -5
- 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/JobsApi.md +4 -4
- 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/TranslationUnreviewParameters.md +17 -0
- data/docs/TranslationUpdateParameters.md +1 -1
- data/docs/TranslationsApi.md +143 -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 +19 -0
- data/docs/TranslationsUnverifyParameters.md +1 -1
- data/docs/TranslationsVerifyParameters.md +1 -1
- data/docs/UploadSummary.md +5 -1
- data/docs/UploadsApi.md +2 -0
- data/lib/phrase/api/branches_api.rb +6 -6
- data/lib/phrase/api/comment_replies_api.rb +4 -12
- data/lib/phrase/api/comments_api.rb +4 -12
- data/lib/phrase/api/invitations_api.rb +14 -14
- data/lib/phrase/api/jobs_api.rb +4 -4
- 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 +170 -16
- data/lib/phrase/api/uploads_api.rb +3 -0
- 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/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/{comments_list_parameters.rb → translation_unreview_parameters.rb} +8 -52
- 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/{replies_list_parameters.rb → translations_unreview_parameters.rb} +12 -34
- data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
- data/lib/phrase/models/translations_verify_parameters.rb +1 -1
- data/lib/phrase/models/upload_summary.rb +22 -4
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +2 -2
- data/spec/api/branches_api_spec.rb +3 -3
- data/spec/api/comment_replies_api_spec.rb +0 -1
- data/spec/api/comments_api_spec.rb +0 -1
- data/spec/api/invitations_api_spec.rb +7 -7
- data/spec/api/jobs_api_spec.rb +2 -2
- 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 +37 -8
- 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
- data/spec/models/translation_unreview_parameters_spec.rb +29 -0
- data/spec/models/translations_unreview_parameters_spec.rb +35 -0
- data/spec/models/upload_summary_spec.rb +12 -0
- metadata +236 -236
- data/docs/CommentsListParameters.md +0 -25
- data/docs/RepliesListParameters.md +0 -23
- data/spec/models/comments_list_parameters_spec.rb +0 -53
- data/spec/models/replies_list_parameters_spec.rb +0 -47
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 948f5fdc24faee23c2c48762da38f24b474b4e194c7b53c67158dc98a42d5753
|
|
4
|
+
data.tar.gz: 804500983b26670344bc10b91dc1cd638da8a724fa8292c2d592ce4a1ca34eec
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 30aeb12b985801bd58736231829c440ea343ff09a5d96b0911d61f15f565b2eaceef62014be0abfdae1dadfbfcb73a56f2c5b11dc50fe69ef5f29ab16d8bf0b1
|
|
7
|
+
data.tar.gz: 225496bb4df91acbaa6902c78ef4c939ac8c067c14869cc73911526b5fa4d51c0165c0e142c93ba24004b63f6f54e56ba821fc3ed4d8f28806f1c9ea28220f7f
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.7.0](https://github.com/phrase/openapi/compare/ruby-v4.6.0...ruby-v4.7.0) (2025-07-18)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **API:** add updated_since param for downloads ([#858](https://github.com/phrase/openapi/issues/858)) ([db4196b](https://github.com/phrase/openapi/commit/db4196bfb1a45f628577bebb99aad7da1179c241))
|
|
9
|
+
* **API:** Add use_ordinal_rules attribute to request body for create/update Keys endpoints ([#868](https://github.com/phrase/openapi/issues/868)) ([29410b5](https://github.com/phrase/openapi/commit/29410b5d4edee9645f449d2d7de53fb953c1f0c2))
|
|
10
|
+
* **API:** Add use_ordinal_rules boolean [STRINGS-2273] ([#846](https://github.com/phrase/openapi/issues/846)) ([450ce0c](https://github.com/phrase/openapi/commit/450ce0cce6bb2064758c44b130b39dd5539c2681))
|
|
11
|
+
|
|
12
|
+
## [4.6.0](https://github.com/phrase/openapi/compare/ruby-v4.5.0...ruby-v4.6.0) (2025-05-23)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **API:** Add omit_statistics param to tags#show ([#834](https://github.com/phrase/openapi/issues/834)) ([2058b18](https://github.com/phrase/openapi/commit/2058b18297133075885ac99770aee2e171811cd6))
|
|
18
|
+
|
|
19
|
+
## [4.5.0](https://github.com/phrase/openapi/compare/ruby-v4.4.0...ruby-v4.5.0) (2025-05-16)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
|
|
24
|
+
* **API:** Add "verify_mentioned_translations" parameter to uploads ([#830](https://github.com/phrase/openapi/issues/830)) ([f2fdf60](https://github.com/phrase/openapi/commit/f2fdf60dd97c3908293cd457a765dafde603bd9b))
|
|
25
|
+
* **API:** Add processed & upload total translations on upload summary ([#824](https://github.com/phrase/openapi/issues/824)) ([081db68](https://github.com/phrase/openapi/commit/081db68d2ffcf5d66a81e07eec0a9572a1f9d633))
|
|
26
|
+
* **API:** Translations unreview & batch unreview ([#831](https://github.com/phrase/openapi/issues/831)) ([6a696db](https://github.com/phrase/openapi/commit/6a696db00d80d8acaf5887a08a7a97997566eb8f))
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
### Bug Fixes
|
|
30
|
+
|
|
31
|
+
* **API:** Remove request body from GET comments ([#817](https://github.com/phrase/openapi/issues/817)) ([2646001](https://github.com/phrase/openapi/commit/264600132e80ac03983e0ae86e99db3d6fb9080d))
|
|
32
|
+
|
|
3
33
|
## [4.4.0](https://github.com/phrase/openapi/compare/ruby-v4.3.0...ruby-v4.4.0) (2025-03-04)
|
|
4
34
|
|
|
5
35
|
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
|
|
|
7
7
|
## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 4.
|
|
10
|
+
- Package version: 4.7.0
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
|
|
13
13
|
|
|
@@ -56,10 +56,10 @@ gem build phrase.gemspec
|
|
|
56
56
|
Then install the gem locally:
|
|
57
57
|
|
|
58
58
|
```shell
|
|
59
|
-
gem install ./phrase-4.
|
|
59
|
+
gem install ./phrase-4.7.0.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./phrase-4.
|
|
62
|
+
(for development, run `gem install --dev ./phrase-4.7.0.gem` to install the development dependencies)
|
|
63
63
|
|
|
64
64
|
## Getting Started
|
|
65
65
|
|
|
@@ -365,6 +365,7 @@ Class | Method | HTTP request | Description
|
|
|
365
365
|
*Phrase::TranslationsApi* | [**translation_include**](docs/TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
|
|
366
366
|
*Phrase::TranslationsApi* | [**translation_review**](docs/TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
|
|
367
367
|
*Phrase::TranslationsApi* | [**translation_show**](docs/TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
|
|
368
|
+
*Phrase::TranslationsApi* | [**translation_unreview**](docs/TranslationsApi.md#translation_unreview) | **PATCH** /projects/{project_id}/translations/{id}/unreview | Unreview a translation
|
|
368
369
|
*Phrase::TranslationsApi* | [**translation_unverify**](docs/TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
|
|
369
370
|
*Phrase::TranslationsApi* | [**translation_update**](docs/TranslationsApi.md#translation_update) | **PATCH** /projects/{project_id}/translations/{id} | Update a translation
|
|
370
371
|
*Phrase::TranslationsApi* | [**translation_verify**](docs/TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
|
|
@@ -375,6 +376,7 @@ Class | Method | HTTP request | Description
|
|
|
375
376
|
*Phrase::TranslationsApi* | [**translations_list**](docs/TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
|
|
376
377
|
*Phrase::TranslationsApi* | [**translations_review_collection**](docs/TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
|
|
377
378
|
*Phrase::TranslationsApi* | [**translations_search**](docs/TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
|
|
379
|
+
*Phrase::TranslationsApi* | [**translations_unreview_collection**](docs/TranslationsApi.md#translations_unreview_collection) | **PATCH** /projects/{project_id}/translations/unreview | Unreview translations selected by query
|
|
378
380
|
*Phrase::TranslationsApi* | [**translations_unverify_collection**](docs/TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
|
|
379
381
|
*Phrase::TranslationsApi* | [**translations_verify_collection**](docs/TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
|
|
380
382
|
*Phrase::UploadsApi* | [**upload_create**](docs/UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
|
|
@@ -424,7 +426,6 @@ Class | Method | HTTP request | Description
|
|
|
424
426
|
- [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
|
|
425
427
|
- [Phrase::CommentReaction](docs/CommentReaction.md)
|
|
426
428
|
- [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
|
|
427
|
-
- [Phrase::CommentsListParameters](docs/CommentsListParameters.md)
|
|
428
429
|
- [Phrase::CurrentUser](docs/CurrentUser.md)
|
|
429
430
|
- [Phrase::CustomMetadataDataType](docs/CustomMetadataDataType.md)
|
|
430
431
|
- [Phrase::CustomMetadataPropertiesCreateParameters](docs/CustomMetadataPropertiesCreateParameters.md)
|
|
@@ -548,7 +549,6 @@ Class | Method | HTTP request | Description
|
|
|
548
549
|
- [Phrase::ReleaseTrigger](docs/ReleaseTrigger.md)
|
|
549
550
|
- [Phrase::ReleaseUpdateParameters](docs/ReleaseUpdateParameters.md)
|
|
550
551
|
- [Phrase::ReleaseUpdateParameters1](docs/ReleaseUpdateParameters1.md)
|
|
551
|
-
- [Phrase::RepliesListParameters](docs/RepliesListParameters.md)
|
|
552
552
|
- [Phrase::RepoSync](docs/RepoSync.md)
|
|
553
553
|
- [Phrase::RepoSyncEvent](docs/RepoSyncEvent.md)
|
|
554
554
|
- [Phrase::Screenshot](docs/Screenshot.md)
|
|
@@ -591,6 +591,7 @@ Class | Method | HTTP request | Description
|
|
|
591
591
|
- [Phrase::TranslationOrder](docs/TranslationOrder.md)
|
|
592
592
|
- [Phrase::TranslationParent](docs/TranslationParent.md)
|
|
593
593
|
- [Phrase::TranslationReviewParameters](docs/TranslationReviewParameters.md)
|
|
594
|
+
- [Phrase::TranslationUnreviewParameters](docs/TranslationUnreviewParameters.md)
|
|
594
595
|
- [Phrase::TranslationUnverifyParameters](docs/TranslationUnverifyParameters.md)
|
|
595
596
|
- [Phrase::TranslationUpdateParameters](docs/TranslationUpdateParameters.md)
|
|
596
597
|
- [Phrase::TranslationVerifyParameters](docs/TranslationVerifyParameters.md)
|
|
@@ -600,6 +601,7 @@ Class | Method | HTTP request | Description
|
|
|
600
601
|
- [Phrase::TranslationsIncludeParameters](docs/TranslationsIncludeParameters.md)
|
|
601
602
|
- [Phrase::TranslationsReviewParameters](docs/TranslationsReviewParameters.md)
|
|
602
603
|
- [Phrase::TranslationsSearchParameters](docs/TranslationsSearchParameters.md)
|
|
604
|
+
- [Phrase::TranslationsUnreviewParameters](docs/TranslationsUnreviewParameters.md)
|
|
603
605
|
- [Phrase::TranslationsUnverifyParameters](docs/TranslationsUnverifyParameters.md)
|
|
604
606
|
- [Phrase::TranslationsVerifyParameters](docs/TranslationsVerifyParameters.md)
|
|
605
607
|
- [Phrase::Upload](docs/Upload.md)
|
data/docs/BranchesApi.md
CHANGED
|
@@ -20,7 +20,7 @@ Method | HTTP request | Description
|
|
|
20
20
|
|
|
21
21
|
Compare branches
|
|
22
22
|
|
|
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
|
|
|
25
25
|
### Example
|
|
26
26
|
|
|
@@ -82,7 +82,7 @@ Response<(nil (empty response body))>
|
|
|
82
82
|
|
|
83
83
|
Create a branch
|
|
84
84
|
|
|
85
|
-
Create a new branch.
|
|
85
|
+
Create a new branch. *Note: Creating a new branch may take several minutes depending on the project size.*
|
|
86
86
|
|
|
87
87
|
### Example
|
|
88
88
|
|
|
@@ -207,7 +207,7 @@ Response<(nil (empty response body))>
|
|
|
207
207
|
|
|
208
208
|
Merge a branch
|
|
209
209
|
|
|
210
|
-
Merge an existing branch.
|
|
210
|
+
Merge an existing branch. *Note: Merging a branch may take several minutes depending on diff size.*
|
|
211
211
|
|
|
212
212
|
### Example
|
|
213
213
|
|
data/docs/CommentRepliesApi.md
CHANGED
|
@@ -15,7 +15,7 @@ Method | HTTP request | Description
|
|
|
15
15
|
|
|
16
16
|
## replies_list
|
|
17
17
|
|
|
18
|
-
> Array<Comment> replies_list(project_id, key_id, comment_id,
|
|
18
|
+
> Array<Comment> replies_list(project_id, key_id, comment_id, opts)
|
|
19
19
|
|
|
20
20
|
List replies
|
|
21
21
|
|
|
@@ -41,7 +41,6 @@ api_instance = Phrase::CommentRepliesApi.new
|
|
|
41
41
|
project_id = 'project_id_example' # String | Project ID
|
|
42
42
|
key_id = 'key_id_example' # String | Translation Key ID
|
|
43
43
|
comment_id = 'comment_id_example' # String | Comment ID
|
|
44
|
-
replies_list_parameters = Phrase::RepliesListParameters.new # RepliesListParameters |
|
|
45
44
|
opts = {
|
|
46
45
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
47
46
|
page: 1, # Integer | Page number
|
|
@@ -54,7 +53,7 @@ opts = {
|
|
|
54
53
|
|
|
55
54
|
begin
|
|
56
55
|
#List replies
|
|
57
|
-
result = api_instance.replies_list(project_id, key_id, comment_id,
|
|
56
|
+
result = api_instance.replies_list(project_id, key_id, comment_id, opts)
|
|
58
57
|
pp result
|
|
59
58
|
rescue Phrase::ApiError => e
|
|
60
59
|
puts "Exception when calling CommentRepliesApi->replies_list: #{e}"
|
|
@@ -69,7 +68,6 @@ Name | Type | Description | Notes
|
|
|
69
68
|
**project_id** | **String**| Project ID |
|
|
70
69
|
**key_id** | **String**| Translation Key ID |
|
|
71
70
|
**comment_id** | **String**| Comment ID |
|
|
72
|
-
**replies_list_parameters** | [**RepliesListParameters**](RepliesListParameters.md)| |
|
|
73
71
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
74
72
|
**page** | **Integer**| Page number | [optional]
|
|
75
73
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
@@ -88,7 +86,7 @@ Response<([**Array<Comment>**](Comment.md))>
|
|
|
88
86
|
|
|
89
87
|
### HTTP request headers
|
|
90
88
|
|
|
91
|
-
- **Content-Type**:
|
|
89
|
+
- **Content-Type**: Not defined
|
|
92
90
|
- **Accept**: application/json
|
|
93
91
|
|
|
94
92
|
|
data/docs/CommentsApi.md
CHANGED
|
@@ -480,7 +480,7 @@ Response<([**Comment**](Comment.md))>
|
|
|
480
480
|
|
|
481
481
|
## comments_list
|
|
482
482
|
|
|
483
|
-
> Array<Comment> comments_list(project_id, key_id,
|
|
483
|
+
> Array<Comment> comments_list(project_id, key_id, opts)
|
|
484
484
|
|
|
485
485
|
List comments
|
|
486
486
|
|
|
@@ -505,7 +505,6 @@ end
|
|
|
505
505
|
api_instance = Phrase::CommentsApi.new
|
|
506
506
|
project_id = 'project_id_example' # String | Project ID
|
|
507
507
|
key_id = 'key_id_example' # String | Translation Key ID
|
|
508
|
-
comments_list_parameters = Phrase::CommentsListParameters.new # CommentsListParameters |
|
|
509
508
|
opts = {
|
|
510
509
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
511
510
|
page: 1, # Integer | Page number
|
|
@@ -519,7 +518,7 @@ opts = {
|
|
|
519
518
|
|
|
520
519
|
begin
|
|
521
520
|
#List comments
|
|
522
|
-
result = api_instance.comments_list(project_id, key_id,
|
|
521
|
+
result = api_instance.comments_list(project_id, key_id, opts)
|
|
523
522
|
pp result
|
|
524
523
|
rescue Phrase::ApiError => e
|
|
525
524
|
puts "Exception when calling CommentsApi->comments_list: #{e}"
|
|
@@ -533,7 +532,6 @@ Name | Type | Description | Notes
|
|
|
533
532
|
------------- | ------------- | ------------- | -------------
|
|
534
533
|
**project_id** | **String**| Project ID |
|
|
535
534
|
**key_id** | **String**| Translation Key ID |
|
|
536
|
-
**comments_list_parameters** | [**CommentsListParameters**](CommentsListParameters.md)| |
|
|
537
535
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
538
536
|
**page** | **Integer**| Page number | [optional]
|
|
539
537
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
@@ -553,6 +551,6 @@ Response<([**Array<Comment>**](Comment.md))>
|
|
|
553
551
|
|
|
554
552
|
### HTTP request headers
|
|
555
553
|
|
|
556
|
-
- **Content-Type**:
|
|
554
|
+
- **Content-Type**: Not defined
|
|
557
555
|
- **Accept**: application/json
|
|
558
556
|
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**project_id** | **String** | Project id the distribution should be assigned to. |
|
|
9
9
|
**platforms** | **Array<String>** | List of platforms the distribution should support. Valid values are: * `android` * `ios` * `flutter` * `i18next` * `rails` | [optional]
|
|
10
10
|
**locale_ids** | **Array<String>** | List of locale ids that will be part of distribution releases | [optional]
|
|
11
|
-
**format_options** | **Hash<String, String>** | Additional formatting and render options. Only
|
|
11
|
+
**format_options** | **Hash<String, String>** | Additional formatting and render options. Only `enclose_in_cdata` is available for platform `android`. | [optional]
|
|
12
12
|
**fallback_locales_enabled** | **Boolean** | Use fallback locale if there is no translation in the current locale. | [optional]
|
|
13
13
|
**fallback_to_non_regional_locale** | **Boolean** | Indicates whether to fallback to non regional locale when locale can not be found | [optional]
|
|
14
14
|
**fallback_to_default_locale** | **Boolean** | Indicates whether to fallback to projects default locale when locale can not be found | [optional]
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**project_id** | **String** | Project id the distribution should be assigned to. | [optional]
|
|
9
9
|
**platforms** | **Array<String>** | List of platforms the distribution should support. | [optional]
|
|
10
10
|
**locale_ids** | **Array<String>** | List of locale ids that will be part of distribution releases | [optional]
|
|
11
|
-
**format_options** | **Hash<String, String>** | Additional formatting and render options. Only
|
|
11
|
+
**format_options** | **Hash<String, String>** | Additional formatting and render options. Only `enclose_in_cdata` is available for platform `android`. | [optional]
|
|
12
12
|
**fallback_locales_enabled** | **Boolean** | Use fallback locale if there is no translation in the current locale. | [optional]
|
|
13
13
|
**fallback_to_non_regional_locale** | **Boolean** | Indicates whether to fallback to non regional locale when locale can not be found | [optional]
|
|
14
14
|
**fallback_to_default_locale** | **Boolean** | Indicates whether to fallback to projects default locale when locale can not be found | [optional]
|
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**email** | **String** | The email of the invited user. The
|
|
7
|
+
**email** | **String** | The email of the invited user. The `email` can not be updated once created. Create a new invitation for each unique email. |
|
|
8
8
|
**role** | **String** | Invitiation role, can be any of Manager, Developer, Translator. |
|
|
9
9
|
**project_ids** | **String** | List of project ids the invited user has access to. | [optional]
|
|
10
10
|
**locale_ids** | **String** | List of locale ids the invited user has access to. | [optional]
|
|
11
11
|
**space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
|
|
12
12
|
**team_ids** | **Array<String>** | List of teams the user is assigned to. | [optional]
|
|
13
13
|
**default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
|
|
14
|
-
**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. Available permissions are
|
|
14
|
+
**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. Available permissions are `create_upload` and `review_translations` | [optional]
|
|
15
15
|
|
|
16
16
|
## Code Sample
|
|
17
17
|
|
data/docs/InvitationsApi.md
CHANGED
|
@@ -20,7 +20,7 @@ Method | HTTP request | Description
|
|
|
20
20
|
|
|
21
21
|
Create a new invitation
|
|
22
22
|
|
|
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
|
|
|
25
25
|
### Example
|
|
26
26
|
|
|
@@ -83,7 +83,7 @@ Response<([**Invitation**](Invitation.md))>
|
|
|
83
83
|
|
|
84
84
|
Delete an invitation
|
|
85
85
|
|
|
86
|
-
Delete an existing invitation (must not be accepted yet). Access token scope must include
|
|
86
|
+
Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`.
|
|
87
87
|
|
|
88
88
|
### Example
|
|
89
89
|
|
|
@@ -145,7 +145,7 @@ Response<(nil (empty response body))>
|
|
|
145
145
|
|
|
146
146
|
Resend an invitation
|
|
147
147
|
|
|
148
|
-
Resend the invitation email (must not be accepted yet). Access token scope must include
|
|
148
|
+
Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`.
|
|
149
149
|
|
|
150
150
|
### Example
|
|
151
151
|
|
|
@@ -208,7 +208,7 @@ Response<([**Invitation**](Invitation.md))>
|
|
|
208
208
|
|
|
209
209
|
Get a single invitation
|
|
210
210
|
|
|
211
|
-
Get details on a single invitation. Access token scope must include
|
|
211
|
+
Get details on a single invitation. Access token scope must include `team.manage`.
|
|
212
212
|
|
|
213
213
|
### Example
|
|
214
214
|
|
|
@@ -271,7 +271,7 @@ Response<([**Invitation**](Invitation.md))>
|
|
|
271
271
|
|
|
272
272
|
Update an invitation
|
|
273
273
|
|
|
274
|
-
Update an existing invitation (must not be accepted yet). The
|
|
274
|
+
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`.
|
|
275
275
|
|
|
276
276
|
### Example
|
|
277
277
|
|
|
@@ -336,7 +336,7 @@ Response<([**Invitation**](Invitation.md))>
|
|
|
336
336
|
|
|
337
337
|
Update a member's invitation access
|
|
338
338
|
|
|
339
|
-
Update member's settings in the invitations. Access token scope must include
|
|
339
|
+
Update member's settings in the invitations. Access token scope must include `team.manage`.
|
|
340
340
|
|
|
341
341
|
### Example
|
|
342
342
|
|
|
@@ -401,7 +401,7 @@ Response<([**Invitation**](Invitation.md))>
|
|
|
401
401
|
|
|
402
402
|
List invitations
|
|
403
403
|
|
|
404
|
-
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
|
|
404
|
+
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`.
|
|
405
405
|
|
|
406
406
|
### Example
|
|
407
407
|
|
data/docs/JobsApi.md
CHANGED
|
@@ -761,7 +761,7 @@ opts = {
|
|
|
761
761
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
762
762
|
owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
|
|
763
763
|
assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
|
|
764
|
-
state: 'completed', # String | filter by state of job; valid states are:
|
|
764
|
+
state: 'completed', # String | filter by state of job; valid states are: `draft`, `in_progress`, `completed`
|
|
765
765
|
updated_since: '2013-02-21T00:00:00.000Z' # String | filter by jobs updated since given date
|
|
766
766
|
}
|
|
767
767
|
|
|
@@ -785,7 +785,7 @@ Name | Type | Description | Notes
|
|
|
785
785
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
786
786
|
**owned_by** | **String**| filter by user owning job | [optional]
|
|
787
787
|
**assigned_to** | **String**| filter by user assigned to job | [optional]
|
|
788
|
-
**state** | **String**| filter by state of job; valid states are:
|
|
788
|
+
**state** | **String**| filter by state of job; valid states are: `draft`, `in_progress`, `completed` | [optional]
|
|
789
789
|
**updated_since** | **String**| filter by jobs updated since given date | [optional]
|
|
790
790
|
|
|
791
791
|
### Return type
|
|
@@ -835,7 +835,7 @@ opts = {
|
|
|
835
835
|
branch: 'my-feature-branch', # String | Branch to use
|
|
836
836
|
owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
|
|
837
837
|
assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
|
|
838
|
-
state: 'completed', # String | filter by state of job; valid states are:
|
|
838
|
+
state: 'completed', # String | filter by state of job; valid states are: `draft`, `in_progress`, `completed`
|
|
839
839
|
updated_since: '2013-02-21T00:00:00.000Z' # String | filter by jobs updated since given date
|
|
840
840
|
}
|
|
841
841
|
|
|
@@ -860,7 +860,7 @@ Name | Type | Description | Notes
|
|
|
860
860
|
**branch** | **String**| Branch to use | [optional]
|
|
861
861
|
**owned_by** | **String**| filter by user owning job | [optional]
|
|
862
862
|
**assigned_to** | **String**| filter by user assigned to job | [optional]
|
|
863
|
-
**state** | **String**| filter by state of job; valid states are:
|
|
863
|
+
**state** | **String**| filter by state of job; valid states are: `draft`, `in_progress`, `completed` | [optional]
|
|
864
864
|
**updated_since** | **String**| filter by jobs updated since given date | [optional]
|
|
865
865
|
|
|
866
866
|
### Return type
|
data/docs/KeyCreateParameters.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Key name |
|
|
9
9
|
**description** | **String** | Key description (usually includes contextual information for translators) | [optional]
|
|
10
10
|
**plural** | **Boolean** | Indicates whether key supports pluralization | [optional]
|
|
11
|
+
**use_ordinal_rules** | **Boolean** | Indicates whether key uses ordinal rules for pluralization | [optional]
|
|
11
12
|
**name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional]
|
|
12
13
|
**data_type** | **String** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional]
|
|
13
14
|
**tags** | **String** | List of tags separated by comma to be associated with the key. | [optional]
|
|
@@ -32,11 +33,12 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
|
|
|
32
33
|
name: home.index.headline,
|
|
33
34
|
description: Some description worth knowing...,
|
|
34
35
|
plural: null,
|
|
36
|
+
use_ordinal_rules: null,
|
|
35
37
|
name_plural: home.index.headlines,
|
|
36
38
|
data_type: number,
|
|
37
39
|
tags: awesome-feature,needs-proofreading,
|
|
38
40
|
max_characters_allowed: 140,
|
|
39
|
-
screenshot: [B@
|
|
41
|
+
screenshot: [B@283dd82a,
|
|
40
42
|
remove_screenshot: null,
|
|
41
43
|
unformatted: null,
|
|
42
44
|
default_translation_content: Default translation content,
|
data/docs/KeyPreview.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**id** | **String** | | [optional]
|
|
8
8
|
**name** | **String** | | [optional]
|
|
9
9
|
**plural** | **Boolean** | | [optional]
|
|
10
|
+
**use_ordinal_rules** | **Boolean** | | [optional]
|
|
10
11
|
|
|
11
12
|
## Code Sample
|
|
12
13
|
|
|
@@ -15,7 +16,8 @@ require 'Phrase'
|
|
|
15
16
|
|
|
16
17
|
instance = Phrase::KeyPreview.new(id: null,
|
|
17
18
|
name: null,
|
|
18
|
-
plural: null
|
|
19
|
+
plural: null,
|
|
20
|
+
use_ordinal_rules: null)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
23
|
|
data/docs/KeyUpdateParameters.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Key name | [optional]
|
|
9
9
|
**description** | **String** | Key description (usually includes contextual information for translators) | [optional]
|
|
10
10
|
**plural** | **Boolean** | Indicates whether key supports pluralization | [optional]
|
|
11
|
+
**use_ordinal_rules** | **Boolean** | Indicates whether key uses ordinal rules for pluralization | [optional]
|
|
11
12
|
**name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional]
|
|
12
13
|
**data_type** | **String** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional]
|
|
13
14
|
**tags** | **String** | List of tags separated by comma to be associated with the key. | [optional]
|
|
@@ -30,11 +31,12 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
|
|
|
30
31
|
name: home.index.headline,
|
|
31
32
|
description: Some description worth knowing...,
|
|
32
33
|
plural: null,
|
|
34
|
+
use_ordinal_rules: null,
|
|
33
35
|
name_plural: home.index.headlines,
|
|
34
36
|
data_type: number,
|
|
35
37
|
tags: awesome-feature,needs-proofreading,
|
|
36
38
|
max_characters_allowed: 140,
|
|
37
|
-
screenshot: [B@
|
|
39
|
+
screenshot: [B@53365a58,
|
|
38
40
|
remove_screenshot: null,
|
|
39
41
|
unformatted: null,
|
|
40
42
|
xml_space_preserve: null,
|
data/docs/KeysApi.md
CHANGED
|
@@ -304,7 +304,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
304
304
|
opts = {
|
|
305
305
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
306
306
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
307
|
-
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards)
|
|
307
|
+
q: 'mykey* translated:true', # 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 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).
|
|
308
308
|
locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
|
309
309
|
}
|
|
310
310
|
|
|
@@ -325,7 +325,7 @@ Name | Type | Description | Notes
|
|
|
325
325
|
**project_id** | **String**| Project ID |
|
|
326
326
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
327
327
|
**branch** | **String**| specify the branch to use | [optional]
|
|
328
|
-
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards)
|
|
328
|
+
**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 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). | [optional]
|
|
329
329
|
**locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
330
330
|
|
|
331
331
|
### Return type
|
|
@@ -501,7 +501,7 @@ opts = {
|
|
|
501
501
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
502
502
|
sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
|
|
503
503
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
504
|
-
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards)
|
|
504
|
+
q: 'mykey* translated:true', # 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 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).
|
|
505
505
|
locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
|
506
506
|
}
|
|
507
507
|
|
|
@@ -526,7 +526,7 @@ Name | Type | Description | Notes
|
|
|
526
526
|
**branch** | **String**| specify the branch to use | [optional]
|
|
527
527
|
**sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional]
|
|
528
528
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
529
|
-
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards)
|
|
529
|
+
**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 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). | [optional]
|
|
530
530
|
**locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
531
531
|
|
|
532
532
|
### Return type
|
|
@@ -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 do broad search for keys by name (including wildcards)
|
|
8
|
+
**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 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [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 do broad search for keys by name (including wildcards)
|
|
8
|
+
**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 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
|
|
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 by field. Can be one of: 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 do broad search for keys by name (including wildcards)
|
|
10
|
+
**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|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 Find more examples [here](/en/api/strings/usage-examples). Please note: If `tags` are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. | [optional]
|
|
11
11
|
**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
data/docs/KeysTagParameters.md
CHANGED
|
@@ -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 do broad search for keys by name (including wildcards)
|
|
8
|
+
**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 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
|
|
11
11
|
|
data/docs/KeysUntagParameters.md
CHANGED
|
@@ -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 do broad search for keys by name (including wildcards)
|
|
8
|
+
**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 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 Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
|
9
9
|
**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
|
10
10
|
**tags** | **String** | Tag or comma-separated list of tags to remove from the matching collection of keys | [optional]
|
|
11
11
|
|
data/docs/Locale.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**main** | **Boolean** | | [optional]
|
|
12
12
|
**rtl** | **Boolean** | | [optional]
|
|
13
13
|
**plural_forms** | **Array<String>** | | [optional]
|
|
14
|
+
**ordinal_plural_forms** | **Array<String>** | | [optional]
|
|
14
15
|
**source_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
15
16
|
**fallback_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
16
17
|
**created_at** | **Time** | | [optional]
|
|
@@ -28,6 +29,7 @@ instance = Phrase::Locale.new(id: null,
|
|
|
28
29
|
main: null,
|
|
29
30
|
rtl: null,
|
|
30
31
|
plural_forms: null,
|
|
32
|
+
ordinal_plural_forms: null,
|
|
31
33
|
source_locale: null,
|
|
32
34
|
fallback_locale: null,
|
|
33
35
|
created_at: null,
|