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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +3 -3
- data/docs/BranchesApi.md +3 -3
- data/docs/DistributionCreateParameters.md +1 -1
- data/docs/DistributionUpdateParameters.md +1 -1
- data/docs/InvitationCreateParameters.md +2 -2
- data/docs/InvitationsApi.md +7 -7
- data/docs/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/TranslationUpdateParameters.md +1 -1
- data/docs/TranslationsApi.md +13 -13
- data/docs/TranslationsExcludeParameters.md +1 -1
- data/docs/TranslationsIncludeParameters.md +1 -1
- data/docs/TranslationsReviewParameters.md +1 -1
- data/docs/TranslationsSearchParameters.md +1 -1
- data/docs/TranslationsUnreviewParameters.md +1 -1
- data/docs/TranslationsUnverifyParameters.md +1 -1
- data/docs/TranslationsVerifyParameters.md +1 -1
- data/lib/phrase/api/branches_api.rb +6 -6
- data/lib/phrase/api/invitations_api.rb +14 -14
- data/lib/phrase/api/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 +16 -16
- data/lib/phrase/models/distribution_create_parameters.rb +1 -1
- data/lib/phrase/models/distribution_update_parameters.rb +1 -1
- data/lib/phrase/models/invitation_create_parameters.rb +2 -2
- data/lib/phrase/models/key_create_parameters.rb +11 -1
- data/lib/phrase/models/key_preview.rb +13 -4
- data/lib/phrase/models/key_update_parameters.rb +11 -1
- data/lib/phrase/models/keys_exclude_parameters.rb +1 -1
- data/lib/phrase/models/keys_include_parameters.rb +1 -1
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/keys_tag_parameters.rb +1 -1
- data/lib/phrase/models/keys_untag_parameters.rb +1 -1
- data/lib/phrase/models/locale.rb +12 -1
- data/lib/phrase/models/locale_create_parameters.rb +3 -3
- data/lib/phrase/models/locale_details.rb +12 -1
- data/lib/phrase/models/locale_download_create_parameters.rb +18 -8
- data/lib/phrase/models/locale_update_parameters.rb +3 -3
- data/lib/phrase/models/member_update_parameters.rb +1 -1
- data/lib/phrase/models/project_create_parameters.rb +4 -4
- data/lib/phrase/models/project_update_parameters.rb +5 -5
- data/lib/phrase/models/screenshot_marker_create_parameters.rb +1 -1
- data/lib/phrase/models/screenshot_marker_update_parameters.rb +1 -1
- data/lib/phrase/models/translation_create_parameters.rb +1 -1
- data/lib/phrase/models/translation_key.rb +10 -1
- data/lib/phrase/models/translation_key_details.rb +10 -1
- data/lib/phrase/models/translation_update_parameters.rb +1 -1
- data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
- data/lib/phrase/models/translations_include_parameters.rb +1 -1
- data/lib/phrase/models/translations_review_parameters.rb +1 -1
- data/lib/phrase/models/translations_search_parameters.rb +1 -1
- data/lib/phrase/models/translations_unreview_parameters.rb +1 -1
- data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
- data/lib/phrase/models/translations_verify_parameters.rb +1 -1
- data/lib/phrase/version.rb +1 -1
- data/spec/api/branches_api_spec.rb +3 -3
- 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 +8 -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
- metadata +231 -231
@@ -22,7 +22,7 @@ describe 'MembersApi' do
|
|
22
22
|
|
23
23
|
# unit tests for member_delete
|
24
24
|
# Remove a user from the account
|
25
|
-
# Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include
|
25
|
+
# Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include `team.manage`.
|
26
26
|
# @param account_id Account ID
|
27
27
|
# @param id ID
|
28
28
|
# @param [Hash] opts the optional parameters
|
@@ -36,7 +36,7 @@ describe 'MembersApi' do
|
|
36
36
|
|
37
37
|
# unit tests for member_show
|
38
38
|
# Get single member
|
39
|
-
# Get details on a single user in the account. Access token scope must include
|
39
|
+
# Get details on a single user in the account. Access token scope must include `team.manage`.
|
40
40
|
# @param account_id Account ID
|
41
41
|
# @param id ID
|
42
42
|
# @param [Hash] opts the optional parameters
|
@@ -50,7 +50,7 @@ describe 'MembersApi' do
|
|
50
50
|
|
51
51
|
# unit tests for member_update
|
52
52
|
# Update a member
|
53
|
-
# Update user permissions in the account. Developers and translators need
|
53
|
+
# Update user permissions in the account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
|
54
54
|
# @param account_id Account ID
|
55
55
|
# @param id ID
|
56
56
|
# @param member_update_parameters
|
@@ -65,7 +65,7 @@ describe 'MembersApi' do
|
|
65
65
|
|
66
66
|
# unit tests for member_update_settings
|
67
67
|
# Update a member's project settings
|
68
|
-
# Update user settings in the project. Access token scope must include
|
68
|
+
# Update user settings in the project. Access token scope must include `team.manage`.
|
69
69
|
# @param project_id Project ID
|
70
70
|
# @param id ID
|
71
71
|
# @param member_update_settings_parameters
|
@@ -80,7 +80,7 @@ describe 'MembersApi' do
|
|
80
80
|
|
81
81
|
# unit tests for members_list
|
82
82
|
# List members
|
83
|
-
# Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include
|
83
|
+
# Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.
|
84
84
|
# @param account_id Account ID
|
85
85
|
# @param [Hash] opts the optional parameters
|
86
86
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
data/spec/api/orders_api_spec.rb
CHANGED
@@ -37,7 +37,7 @@ describe 'OrdersApi' do
|
|
37
37
|
|
38
38
|
# unit tests for order_create
|
39
39
|
# Create a new order
|
40
|
-
# Create a new order. Access token scope must include
|
40
|
+
# Create a new order. Access token scope must include `orders.create`.
|
41
41
|
# @param project_id Project ID
|
42
42
|
# @param order_create_parameters
|
43
43
|
# @param [Hash] opts the optional parameters
|
@@ -52,7 +52,7 @@ describe 'ReleaseTriggersApi' do
|
|
52
52
|
|
53
53
|
# unit tests for release_triggers_list
|
54
54
|
# List release triggers
|
55
|
-
# List all release triggers for the given distribution
|
55
|
+
# List all release triggers for the given distribution. Note: Currently only one release trigger can exist per distribution.
|
56
56
|
# @param account_id Account ID
|
57
57
|
# @param distribution_id Distribution ID
|
58
58
|
# @param [Hash] opts the optional parameters
|
data/spec/api/search_api_spec.rb
CHANGED
@@ -22,7 +22,7 @@ describe 'SearchApi' do
|
|
22
22
|
|
23
23
|
# unit tests for search_in_account
|
24
24
|
# Search across projects
|
25
|
-
# Search for keys and translations in all account projects
|
25
|
+
# Search for keys and translations in all account projects *Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.*
|
26
26
|
# @param account_id Account ID
|
27
27
|
# @param search_in_account_parameters
|
28
28
|
# @param [Hash] opts the optional parameters
|
data/spec/api/tags_api_spec.rb
CHANGED
@@ -56,6 +56,7 @@ describe 'TagsApi' do
|
|
56
56
|
# @param name name
|
57
57
|
# @param [Hash] opts the optional parameters
|
58
58
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
59
|
+
# @option opts [Boolean] :omit_statistics omit statistics in the response
|
59
60
|
# @option opts [String] :branch specify the branch to use
|
60
61
|
# @return [TagWithStats]
|
61
62
|
describe 'tag_show test' do
|
@@ -166,7 +166,7 @@ describe 'TranslationsApi' do
|
|
166
166
|
# @option opts [String] :branch specify the branch to use
|
167
167
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
168
168
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
169
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards)
|
169
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards). The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `unverified:{true|false}` for verification status * `tags:XYZ` for tags on the translation * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
170
170
|
# @return [Array<Translation>]
|
171
171
|
describe 'translations_by_key test' do
|
172
172
|
it 'should work' do
|
@@ -176,7 +176,7 @@ describe 'TranslationsApi' do
|
|
176
176
|
|
177
177
|
# unit tests for translations_by_locale
|
178
178
|
# List translations by locale
|
179
|
-
# List translations for a specific locale. If you want to download all translations for one locale we recommend to use the
|
179
|
+
# List translations for a specific locale. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
180
180
|
# @param project_id Project ID
|
181
181
|
# @param locale_id Locale ID
|
182
182
|
# @param [Hash] opts the optional parameters
|
@@ -186,7 +186,7 @@ describe 'TranslationsApi' do
|
|
186
186
|
# @option opts [String] :branch specify the branch to use
|
187
187
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
188
188
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
189
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards)
|
189
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: - `id:translation_id,...` for queries on a comma-separated list of ids - `unverified:{true|false}` for verification status - `tags:XYZ` for tags on the translation - `excluded:{true|false}` for exclusion status - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
190
190
|
# @return [Array<Translation>]
|
191
191
|
describe 'translations_by_locale test' do
|
192
192
|
it 'should work' do
|
@@ -224,18 +224,18 @@ describe 'TranslationsApi' do
|
|
224
224
|
|
225
225
|
# unit tests for translations_list
|
226
226
|
# List all translations
|
227
|
-
# List translations for the given project. If you want to download all translations for one locale we recommend to use the
|
227
|
+
# List translations for the given project. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
228
228
|
# @param project_id Project ID
|
229
229
|
# @param [Hash] opts the optional parameters
|
230
230
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
231
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
232
|
-
# @option opts [String] :if_none_match ETag condition, see
|
231
|
+
# @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
232
|
+
# @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
|
233
233
|
# @option opts [Integer] :page Page number
|
234
234
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
235
235
|
# @option opts [String] :branch specify the branch to use
|
236
236
|
# @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
|
237
237
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
238
|
-
# @option opts [String] :q Specify a query to find translations by content (including wildcards)
|
238
|
+
# @option opts [String] :q Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples).
|
239
239
|
# @return [Array<Translation>]
|
240
240
|
describe 'translations_list test' do
|
241
241
|
it 'should work' do
|
@@ -259,7 +259,7 @@ describe 'TranslationsApi' do
|
|
259
259
|
|
260
260
|
# unit tests for translations_search
|
261
261
|
# Search translations
|
262
|
-
# Search translations for the given project. Provides the same search interface as
|
262
|
+
# Search translations for the given project. Provides the same search interface as `translations#index` but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.
|
263
263
|
# @param project_id Project ID
|
264
264
|
# @param translations_search_parameters
|
265
265
|
# @param [Hash] opts the optional parameters
|
@@ -44,6 +44,12 @@ describe 'KeyCreateParameters' do
|
|
44
44
|
end
|
45
45
|
end
|
46
46
|
|
47
|
+
describe 'test attribute "use_ordinal_rules"' do
|
48
|
+
it 'should work' do
|
49
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
47
53
|
describe 'test attribute "name_plural"' do
|
48
54
|
it 'should work' do
|
49
55
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -44,6 +44,12 @@ describe 'KeyUpdateParameters' do
|
|
44
44
|
end
|
45
45
|
end
|
46
46
|
|
47
|
+
describe 'test attribute "use_ordinal_rules"' do
|
48
|
+
it 'should work' do
|
49
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
47
53
|
describe 'test attribute "name_plural"' do
|
48
54
|
it 'should work' do
|
49
55
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -62,6 +62,12 @@ describe 'LocaleDetails' do
|
|
62
62
|
end
|
63
63
|
end
|
64
64
|
|
65
|
+
describe 'test attribute "ordinal_plural_forms"' do
|
66
|
+
it 'should work' do
|
67
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
65
71
|
describe 'test attribute "source_locale"' do
|
66
72
|
it 'should work' do
|
67
73
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -110,4 +110,10 @@ describe 'LocaleDownloadCreateParameters' do
|
|
110
110
|
end
|
111
111
|
end
|
112
112
|
|
113
|
+
describe 'test attribute "updated_since"' do
|
114
|
+
it 'should work' do
|
115
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
116
|
+
end
|
117
|
+
end
|
118
|
+
|
113
119
|
end
|
data/spec/models/locale_spec.rb
CHANGED
@@ -62,6 +62,12 @@ describe 'Locale' do
|
|
62
62
|
end
|
63
63
|
end
|
64
64
|
|
65
|
+
describe 'test attribute "ordinal_plural_forms"' do
|
66
|
+
it 'should work' do
|
67
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
65
71
|
describe 'test attribute "source_locale"' do
|
66
72
|
it 'should work' do
|
67
73
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -50,6 +50,12 @@ describe 'TranslationKeyDetails' do
|
|
50
50
|
end
|
51
51
|
end
|
52
52
|
|
53
|
+
describe 'test attribute "use_ordinal_rules"' do
|
54
|
+
it 'should work' do
|
55
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
53
59
|
describe 'test attribute "tags"' do
|
54
60
|
it 'should work' do
|
55
61
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -50,6 +50,12 @@ describe 'TranslationKey' do
|
|
50
50
|
end
|
51
51
|
end
|
52
52
|
|
53
|
+
describe 'test attribute "use_ordinal_rules"' do
|
54
|
+
it 'should work' do
|
55
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
53
59
|
describe 'test attribute "tags"' do
|
54
60
|
it 'should work' do
|
55
61
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|