phrase 4.5.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.
Files changed (113) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +3 -3
  4. data/docs/BranchesApi.md +3 -3
  5. data/docs/DistributionCreateParameters.md +1 -1
  6. data/docs/DistributionUpdateParameters.md +1 -1
  7. data/docs/InvitationCreateParameters.md +2 -2
  8. data/docs/InvitationsApi.md +7 -7
  9. data/docs/JobsApi.md +4 -4
  10. data/docs/KeyCreateParameters.md +3 -1
  11. data/docs/KeyPreview.md +3 -1
  12. data/docs/KeyUpdateParameters.md +3 -1
  13. data/docs/KeysApi.md +4 -4
  14. data/docs/KeysExcludeParameters.md +1 -1
  15. data/docs/KeysIncludeParameters.md +1 -1
  16. data/docs/KeysSearchParameters.md +1 -1
  17. data/docs/KeysTagParameters.md +1 -1
  18. data/docs/KeysUntagParameters.md +1 -1
  19. data/docs/Locale.md +2 -0
  20. data/docs/LocaleCreateParameters.md +3 -3
  21. data/docs/LocaleDetails.md +2 -0
  22. data/docs/LocaleDownloadCreateParameters.md +7 -5
  23. data/docs/LocaleDownloadsApi.md +8 -8
  24. data/docs/LocaleUpdateParameters.md +3 -3
  25. data/docs/LocalesApi.md +17 -15
  26. data/docs/MemberUpdateParameters.md +1 -1
  27. data/docs/MembersApi.md +5 -5
  28. data/docs/OrdersApi.md +1 -1
  29. data/docs/ProjectCreateParameters.md +5 -5
  30. data/docs/ProjectUpdateParameters.md +6 -6
  31. data/docs/ReleaseTriggersApi.md +1 -1
  32. data/docs/ScreenshotMarkerCreateParameters.md +1 -1
  33. data/docs/ScreenshotMarkerUpdateParameters.md +1 -1
  34. data/docs/ScreenshotUpdateParameters.md +1 -1
  35. data/docs/SearchApi.md +1 -1
  36. data/docs/TagsApi.md +2 -0
  37. data/docs/TranslationCreateParameters.md +1 -1
  38. data/docs/TranslationKey.md +2 -0
  39. data/docs/TranslationKeyDetails.md +2 -0
  40. data/docs/TranslationUpdateParameters.md +1 -1
  41. data/docs/TranslationsApi.md +13 -13
  42. data/docs/TranslationsExcludeParameters.md +1 -1
  43. data/docs/TranslationsIncludeParameters.md +1 -1
  44. data/docs/TranslationsReviewParameters.md +1 -1
  45. data/docs/TranslationsSearchParameters.md +1 -1
  46. data/docs/TranslationsUnreviewParameters.md +1 -1
  47. data/docs/TranslationsUnverifyParameters.md +1 -1
  48. data/docs/TranslationsVerifyParameters.md +1 -1
  49. data/lib/phrase/api/branches_api.rb +6 -6
  50. data/lib/phrase/api/invitations_api.rb +14 -14
  51. data/lib/phrase/api/jobs_api.rb +4 -4
  52. data/lib/phrase/api/keys_api.rb +4 -4
  53. data/lib/phrase/api/locale_downloads_api.rb +8 -8
  54. data/lib/phrase/api/locales_api.rb +17 -14
  55. data/lib/phrase/api/members_api.rb +10 -10
  56. data/lib/phrase/api/orders_api.rb +2 -2
  57. data/lib/phrase/api/release_triggers_api.rb +2 -2
  58. data/lib/phrase/api/search_api.rb +2 -2
  59. data/lib/phrase/api/tags_api.rb +3 -0
  60. data/lib/phrase/api/translations_api.rb +16 -16
  61. data/lib/phrase/models/distribution_create_parameters.rb +1 -1
  62. data/lib/phrase/models/distribution_update_parameters.rb +1 -1
  63. data/lib/phrase/models/invitation_create_parameters.rb +2 -2
  64. data/lib/phrase/models/key_create_parameters.rb +11 -1
  65. data/lib/phrase/models/key_preview.rb +13 -4
  66. data/lib/phrase/models/key_update_parameters.rb +11 -1
  67. data/lib/phrase/models/keys_exclude_parameters.rb +1 -1
  68. data/lib/phrase/models/keys_include_parameters.rb +1 -1
  69. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  70. data/lib/phrase/models/keys_tag_parameters.rb +1 -1
  71. data/lib/phrase/models/keys_untag_parameters.rb +1 -1
  72. data/lib/phrase/models/locale.rb +12 -1
  73. data/lib/phrase/models/locale_create_parameters.rb +3 -3
  74. data/lib/phrase/models/locale_details.rb +12 -1
  75. data/lib/phrase/models/locale_download_create_parameters.rb +18 -8
  76. data/lib/phrase/models/locale_update_parameters.rb +3 -3
  77. data/lib/phrase/models/member_update_parameters.rb +1 -1
  78. data/lib/phrase/models/project_create_parameters.rb +4 -4
  79. data/lib/phrase/models/project_update_parameters.rb +5 -5
  80. data/lib/phrase/models/screenshot_marker_create_parameters.rb +1 -1
  81. data/lib/phrase/models/screenshot_marker_update_parameters.rb +1 -1
  82. data/lib/phrase/models/translation_create_parameters.rb +1 -1
  83. data/lib/phrase/models/translation_key.rb +10 -1
  84. data/lib/phrase/models/translation_key_details.rb +10 -1
  85. data/lib/phrase/models/translation_update_parameters.rb +1 -1
  86. data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
  87. data/lib/phrase/models/translations_include_parameters.rb +1 -1
  88. data/lib/phrase/models/translations_review_parameters.rb +1 -1
  89. data/lib/phrase/models/translations_search_parameters.rb +1 -1
  90. data/lib/phrase/models/translations_unreview_parameters.rb +1 -1
  91. data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
  92. data/lib/phrase/models/translations_verify_parameters.rb +1 -1
  93. data/lib/phrase/version.rb +1 -1
  94. data/spec/api/branches_api_spec.rb +3 -3
  95. data/spec/api/invitations_api_spec.rb +7 -7
  96. data/spec/api/jobs_api_spec.rb +2 -2
  97. data/spec/api/keys_api_spec.rb +2 -2
  98. data/spec/api/locale_downloads_api_spec.rb +4 -4
  99. data/spec/api/members_api_spec.rb +5 -5
  100. data/spec/api/orders_api_spec.rb +1 -1
  101. data/spec/api/release_triggers_api_spec.rb +1 -1
  102. data/spec/api/search_api_spec.rb +1 -1
  103. data/spec/api/tags_api_spec.rb +1 -0
  104. data/spec/api/translations_api_spec.rb +8 -8
  105. data/spec/models/key_create_parameters_spec.rb +6 -0
  106. data/spec/models/key_preview_spec.rb +6 -0
  107. data/spec/models/key_update_parameters_spec.rb +6 -0
  108. data/spec/models/locale_details_spec.rb +6 -0
  109. data/spec/models/locale_download_create_parameters_spec.rb +6 -0
  110. data/spec/models/locale_spec.rb +6 -0
  111. data/spec/models/translation_key_details_spec.rb +6 -0
  112. data/spec/models/translation_key_spec.rb +6 -0
  113. metadata +231 -231
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 04bf3ebdd9d603c87adf2947d530e382f37097aee543be5b2cb4dccd7db69534
4
- data.tar.gz: 2dc353e4330710c12f66deab8bd9faf89561c5d3412ba5dd2fdd4d110691906d
3
+ metadata.gz: 948f5fdc24faee23c2c48762da38f24b474b4e194c7b53c67158dc98a42d5753
4
+ data.tar.gz: 804500983b26670344bc10b91dc1cd638da8a724fa8292c2d592ce4a1ca34eec
5
5
  SHA512:
6
- metadata.gz: 72b9f71936dc753d69b3dd654bbd780f81dee8d51dcf726c50b9759b08fc8bc6d41fb70b0c7a5931e94506cc304baa456cf405d39af80d4e29dccfb519637149
7
- data.tar.gz: 6355285399a4b1257e7961bb3b3efdb4a5b184314855b89039ad3d49b855ff53a5b3dfe69d2011a9d8ec9d4dee1b59ac1e60191a98085eddb8376a7670445101
6
+ metadata.gz: 30aeb12b985801bd58736231829c440ea343ff09a5d96b0911d61f15f565b2eaceef62014be0abfdae1dadfbfcb73a56f2c5b11dc50fe69ef5f29ab16d8bf0b1
7
+ data.tar.gz: 225496bb4df91acbaa6902c78ef4c939ac8c067c14869cc73911526b5fa4d51c0165c0e142c93ba24004b63f6f54e56ba821fc3ed4d8f28806f1c9ea28220f7f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
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
+
3
19
  ## [4.5.0](https://github.com/phrase/openapi/compare/ruby-v4.4.0...ruby-v4.5.0) (2025-05-16)
4
20
 
5
21
 
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.5.0
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.5.0.gem
59
+ gem install ./phrase-4.7.0.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-4.5.0.gem` to install the development dependencies)
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
 
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. <br><br><i>Note: Comparing a branch may take several minutes depending on the project size.</i>
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. <br><br><i>Note: Creating a new branch may take several minutes depending on the project size.</i>
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. <br><br><i>Note: Merging a branch may take several minutes depending on diff size.</i>
210
+ Merge an existing branch. *Note: Merging a branch may take several minutes depending on diff size.*
211
211
 
212
212
  ### Example
213
213
 
@@ -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&lt;String&gt;** | List of platforms the distribution should support. Valid values are: * &#x60;android&#x60; * &#x60;ios&#x60; * &#x60;flutter&#x60; * &#x60;i18next&#x60; * &#x60;rails&#x60; | [optional]
10
10
  **locale_ids** | **Array&lt;String&gt;** | List of locale ids that will be part of distribution releases | [optional]
11
- **format_options** | **Hash&lt;String, String&gt;** | Additional formatting and render options. Only &lt;code&gt;enclose_in_cdata&lt;/code&gt; is available for platform &lt;code&gt;android&lt;/code&gt;. | [optional]
11
+ **format_options** | **Hash&lt;String, String&gt;** | Additional formatting and render options. Only &#x60;enclose_in_cdata&#x60; is available for platform &#x60;android&#x60;. | [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&lt;String&gt;** | List of platforms the distribution should support. | [optional]
10
10
  **locale_ids** | **Array&lt;String&gt;** | List of locale ids that will be part of distribution releases | [optional]
11
- **format_options** | **Hash&lt;String, String&gt;** | Additional formatting and render options. Only &lt;code&gt;enclose_in_cdata&lt;/code&gt; is available for platform &lt;code&gt;android&lt;/code&gt;. | [optional]
11
+ **format_options** | **Hash&lt;String, String&gt;** | Additional formatting and render options. Only &#x60;enclose_in_cdata&#x60; is available for platform &#x60;android&#x60;. | [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 &lt;code&gt;email&lt;/code&gt; can not be updated once created. Create a new invitation for each unique email. |
7
+ **email** | **String** | The email of the invited user. The &#x60;email&#x60; 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&lt;String&gt;** | List of spaces the user is assigned to. | [optional]
12
12
  **team_ids** | **Array&lt;String&gt;** | List of teams the user is assigned to. | [optional]
13
13
  **default_locale_codes** | **Array&lt;String&gt;** | List of default locales for the user. | [optional]
14
- **permissions** | **Hash&lt;String, String&gt;** | Additional permissions depending on invitation role. Available permissions are &lt;code&gt;create_upload&lt;/code&gt; and &lt;code&gt;review_translations&lt;/code&gt; | [optional]
14
+ **permissions** | **Hash&lt;String, String&gt;** | Additional permissions depending on invitation role. Available permissions are &#x60;create_upload&#x60; and &#x60;review_translations&#x60; | [optional]
15
15
 
16
16
  ## Code Sample
17
17
 
@@ -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 <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.
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 <code>team.manage</code>.
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 <code>team.manage</code>.
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 <code>team.manage</code>.
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 <code>email</code> cannot be updated. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.
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 <code>team.manage</code>.
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 <code>team.manage</code>.
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: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
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: &lt;code&gt;draft&lt;/code&gt;, &lt;code&gt;in_progress&lt;/code&gt;, &lt;code&gt;completed&lt;/code&gt; | [optional]
788
+ **state** | **String**| filter by state of job; valid states are: &#x60;draft&#x60;, &#x60;in_progress&#x60;, &#x60;completed&#x60; | [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: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
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: &lt;code&gt;draft&lt;/code&gt;, &lt;code&gt;in_progress&lt;/code&gt;, &lt;code&gt;completed&lt;/code&gt; | [optional]
863
+ **state** | **String**| filter by state of job; valid states are: &#x60;draft&#x60;, &#x60;in_progress&#x60;, &#x60;completed&#x60; | [optional]
864
864
  **updated_since** | **String**| filter by jobs updated since given date | [optional]
865
865
 
866
866
  ### Return type
@@ -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@905e189,
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
 
@@ -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@7b31281b,
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).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>.
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).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; &lt;br/&gt; &lt;p&gt;&lt;strong&gt;Caution:&lt;/strong&gt; Query parameters with empty values will be treated as though they are not included in the request and will be ignored.&lt;/p&gt; &lt;br/&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
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: - &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids - &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes - &#x60;tags:tag_name&#x60; to filter for keys with certain tags - &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) - &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries - &#x60;unmentioned_in_upload:upload_id,...&#x60; 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).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>.
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).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; &lt;br/&gt; &lt;p&gt;&lt;strong&gt;Caution:&lt;/strong&gt; Query parameters with empty values will be treated as though they are not included in the request and will be ignored.&lt;/p&gt; &lt;br/&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
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: - &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids - &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes - &#x60;tags:tag_name&#x60; to filter for keys with certain tags - &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) - &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries - &#x60;unmentioned_in_upload:upload_id,...&#x60; 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).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
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: - &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids - &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes - &#x60;tags:tag_name&#x60; to filter for keys with certain tags - &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) - &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries - &#x60;unmentioned_in_upload:upload_id,...&#x60; 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).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
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: * &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids * &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes * &#x60;tags:tag_name&#x60; to filter for keys with certain tags * &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) * &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries * &#x60;unmentioned_in_upload:upload_id,...&#x60; 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).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name,...&lt;/code&gt; for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name,...&lt;/code&gt; to filter for keys with certain comma-seperated list of tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;uploads:upload_id,...&lt;/code&gt; to filter for keys with certain comma-seperated list of uploads&lt;/li&gt; &lt;li&gt;&lt;code&gt;job:{true|false}&lt;/code&gt; to filter for keys mentioned in an active job&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&amp;gt;&#x3D;|&amp;lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. Please note: If &lt;code&gt;tags&lt;/code&gt; are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. | [optional]
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: * &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids * &#x60;name:key_name,...&#x60; for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes * &#x60;tags:tag_name,...&#x60; to filter for keys with certain comma-seperated list of tags * &#x60;uploads:upload_id,...&#x60; to filter for keys with certain comma-seperated list of uploads * &#x60;job:{true|false}&#x60; to filter for keys mentioned in an active job * &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) * &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries * &#x60;unmentioned_in_upload:upload_id,...&#x60; 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 &#x60;tags&#x60; 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
@@ -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).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
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: * &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids * &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes * &#x60;tags:tag_name&#x60; to filter for keys with certain tags * &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) * &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries * &#x60;unmentioned_in_upload:upload_id,...&#x60; 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
 
@@ -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).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
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: * &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids * &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes * &#x60;tags:tag_name&#x60; to filter for keys with certain tags * &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) * &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries * &#x60;unmentioned_in_upload:upload_id,...&#x60; 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&lt;String&gt;** | | [optional]
14
+ **ordinal_plural_forms** | **Array&lt;String&gt;** | | [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,
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
8
8
  **name** | **String** | Locale name |
9
9
  **code** | **String** | Locale ISO code |
10
10
  **default** | **Boolean** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional]
11
- **main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Verification System&lt;/a&gt; feature. | [optional]
11
+ **main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the [Verification System](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
12
12
  **rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional]
13
13
  **source_locale_id** | **String** | Source locale. Can be the name or id of the locale. Preferred is id. | [optional]
14
14
  **fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. | [optional]
15
- **unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional]
16
- **unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional]
15
+ **unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
16
+ **unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
17
17
  **autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional]
18
18
 
19
19
  ## Code Sample
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
11
11
  **main** | **Boolean** | | [optional]
12
12
  **rtl** | **Boolean** | | [optional]
13
13
  **plural_forms** | **Array&lt;String&gt;** | | [optional]
14
+ **ordinal_plural_forms** | **Array&lt;String&gt;** | | [optional]
14
15
  **source_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
15
16
  **fallback_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
16
17
  **created_at** | **Time** | | [optional]
@@ -29,6 +30,7 @@ instance = Phrase::LocaleDetails.new(id: null,
29
30
  main: null,
30
31
  rtl: null,
31
32
  plural_forms: null,
33
+ ordinal_plural_forms: null,
32
34
  source_locale: null,
33
35
  fallback_locale: null,
34
36
  created_at: null,
@@ -4,21 +4,22 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **file_format** | **String** | File format name. See the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/sections/6111343326364\&quot;&gt;format guide&lt;/a&gt; for all supported file formats. |
7
+ **file_format** | **String** | File format name. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for all supported file formats. |
8
8
  **branch** | **String** | specify the branch to use | [optional]
9
9
  **tags** | **String** | Limit results to keys tagged with a list of comma separated tag names. | [optional]
10
10
  **include_empty_translations** | **Boolean** | Indicates whether keys without translations should be included in the output as well. | [optional]
11
11
  **exclude_empty_zero_forms** | **Boolean** | Indicates whether zero forms should be included when empty in pluralized keys. | [optional]
12
12
  **include_translated_keys** | **Boolean** | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional]
13
13
  **keep_notranslate_tags** | **Boolean** | Indicates whether [NOTRANSLATE] tags should be kept. | [optional]
14
- **format_options** | **Object** | Additional formatting and render options. See the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/sections/6111343326364\&quot;&gt;format guide&lt;/a&gt; for a list of options available for each format. Specify format options like this: &lt;code&gt;...&amp;format_options[foo]&#x3D;bar&lt;/code&gt; | [optional]
14
+ **format_options** | **Object** | 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: &#x60;...&amp;format_options[foo]&#x3D;bar&#x60; | [optional]
15
15
  **encoding** | **String** | Enforces a specific encoding on the file contents. Valid options are \&quot;UTF-8\&quot;, \&quot;UTF-16\&quot; and \&quot;ISO-8859-1\&quot;. | [optional]
16
16
  **include_unverified_translations** | **Boolean** | if set to false unverified translations are excluded | [optional]
17
17
  **use_last_reviewed_version** | **Boolean** | 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. | [optional]
18
18
  **locale_ids** | **Array&lt;String&gt;** | Locale IDs or locale names | [optional]
19
- **fallback_locale_id** | **String** | 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 &lt;code&gt;true&lt;/code&gt;. | [optional]
20
- **source_locale_id** | **String** | 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 &lt;code&gt;tag&lt;/code&gt; parameter indicating a specific job. | [optional]
19
+ **fallback_locale_id** | **String** | 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 &#x60;true&#x60;. | [optional]
20
+ **source_locale_id** | **String** | 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 &#x60;tag&#x60; parameter indicating a specific job. | [optional]
21
21
  **custom_metadata_filters** | **Object** | 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. | [optional]
22
+ **updated_since** | **String** | Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., &#x60;2023-01-01T00:00:00Z&#x60;). | [optional]
22
23
 
23
24
  ## Code Sample
24
25
 
@@ -39,7 +40,8 @@ instance = Phrase::LocaleDownloadCreateParameters.new(file_format: yml,
39
40
  locale_ids: [&quot;de&quot;,&quot;en&quot;],
40
41
  fallback_locale_id: abcd1234abcd1234abcd1234abcd1234,
41
42
  source_locale_id: abcd1234abcd1234abcd1234abcd1234,
42
- custom_metadata_filters: null)
43
+ custom_metadata_filters: null,
44
+ updated_since: 2023-01-01T00:00:00Z)
43
45
  ```
44
46
 
45
47
 
@@ -39,8 +39,8 @@ locale_id = 'locale_id_example' # String | Locale ID
39
39
  locale_download_create_parameters = Phrase::LocaleDownloadCreateParameters.new({file_format: 'yml'}) # LocaleDownloadCreateParameters |
40
40
  opts = {
41
41
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
42
- if_modified_since: 'if_modified_since_example', # String | Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
43
- if_none_match: 'if_none_match_example' # String | ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
42
+ 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)
43
+ 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)
44
44
  }
45
45
 
46
46
  begin
@@ -61,8 +61,8 @@ Name | Type | Description | Notes
61
61
  **locale_id** | **String**| Locale ID |
62
62
  **locale_download_create_parameters** | [**LocaleDownloadCreateParameters**](LocaleDownloadCreateParameters.md)| |
63
63
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
64
- **if_modified_since** | **String**| Last modified condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional) | [optional]
65
- **if_none_match** | **String**| ETag condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional) | [optional]
64
+ **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]
65
+ **if_none_match** | **String**| ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
66
66
 
67
67
  ### Return type
68
68
 
@@ -108,8 +108,8 @@ locale_id = 'locale_id_example' # String | Locale ID
108
108
  id = 'id_example' # String | ID
109
109
  opts = {
110
110
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
111
- if_modified_since: 'if_modified_since_example', # String | Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
112
- if_none_match: 'if_none_match_example' # String | ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
111
+ 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)
112
+ 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)
113
113
  }
114
114
 
115
115
  begin
@@ -130,8 +130,8 @@ Name | Type | Description | Notes
130
130
  **locale_id** | **String**| Locale ID |
131
131
  **id** | **String**| ID |
132
132
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
133
- **if_modified_since** | **String**| Last modified condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional) | [optional]
134
- **if_none_match** | **String**| ETag condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional) | [optional]
133
+ **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]
134
+ **if_none_match** | **String**| ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional) | [optional]
135
135
 
136
136
  ### Return type
137
137
 
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
8
8
  **name** | **String** | Locale name | [optional]
9
9
  **code** | **String** | Locale ISO code | [optional]
10
10
  **default** | **Boolean** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional]
11
- **main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Verification System&lt;/a&gt; feature. | [optional]
11
+ **main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the [Verification System](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
12
12
  **rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional]
13
13
  **source_locale_id** | **String** | Source locale. Can be the name or id of the locale. Preferred is id. | [optional]
14
14
  **fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. | [optional]
15
- **unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional]
16
- **unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional]
15
+ **unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
16
+ **unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
17
17
  **autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional]
18
18
 
19
19
  ## Code Sample