phrase 4.5.0 → 4.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +12 -3
- data/docs/BranchesApi.md +3 -3
- data/docs/DistributionCreateParameters.md +1 -1
- data/docs/DistributionUpdateParameters.md +1 -1
- data/docs/InvitationCreateParameters.md +2 -2
- data/docs/InvitationsApi.md +7 -7
- data/docs/JobAnnotation.md +23 -0
- data/docs/JobAnnotationShort.md +19 -0
- data/docs/JobAnnotationUpdateParameters.md +19 -0
- data/docs/JobAnnotationsApi.md +416 -0
- data/docs/JobDetails.md +3 -1
- data/docs/JobLocale.md +3 -1
- data/docs/JobLocalesApi.md +6 -2
- data/docs/JobsApi.md +8 -6
- data/docs/KeyCreateParameters.md +3 -1
- data/docs/KeyPreview.md +3 -1
- data/docs/KeyUpdateParameters.md +3 -1
- data/docs/KeysApi.md +4 -4
- data/docs/KeysExcludeParameters.md +1 -1
- data/docs/KeysIncludeParameters.md +1 -1
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/KeysTagParameters.md +1 -1
- data/docs/KeysUntagParameters.md +1 -1
- data/docs/Locale.md +2 -0
- data/docs/LocaleCreateParameters.md +3 -3
- data/docs/LocaleDetails.md +2 -0
- data/docs/LocaleDownloadCreateParameters.md +7 -5
- data/docs/LocaleDownloadsApi.md +8 -8
- data/docs/LocaleUpdateParameters.md +3 -3
- data/docs/LocalesApi.md +17 -15
- data/docs/MemberUpdateParameters.md +1 -1
- data/docs/MembersApi.md +5 -5
- data/docs/OrdersApi.md +1 -1
- data/docs/ProjectCreateParameters.md +5 -5
- data/docs/ProjectUpdateParameters.md +6 -6
- data/docs/ReleaseTriggersApi.md +1 -1
- data/docs/ScreenshotMarkerCreateParameters.md +1 -1
- data/docs/ScreenshotMarkerUpdateParameters.md +1 -1
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/docs/SearchApi.md +1 -1
- data/docs/TagsApi.md +2 -0
- data/docs/TranslationCreateParameters.md +1 -1
- data/docs/TranslationKey.md +2 -0
- data/docs/TranslationKeyDetails.md +2 -0
- data/docs/TranslationUpdateParameters.md +1 -1
- data/docs/TranslationsApi.md +13 -13
- data/docs/TranslationsExcludeParameters.md +1 -1
- data/docs/TranslationsIncludeParameters.md +1 -1
- data/docs/TranslationsReviewParameters.md +1 -1
- data/docs/TranslationsSearchParameters.md +1 -1
- data/docs/TranslationsUnreviewParameters.md +1 -1
- data/docs/TranslationsUnverifyParameters.md +1 -1
- data/docs/TranslationsVerifyParameters.md +1 -1
- data/lib/phrase/api/branches_api.rb +6 -6
- data/lib/phrase/api/invitations_api.rb +14 -14
- data/lib/phrase/api/job_annotations_api.rb +508 -0
- data/lib/phrase/api/job_locales_api.rb +6 -0
- data/lib/phrase/api/jobs_api.rb +9 -6
- data/lib/phrase/api/keys_api.rb +4 -4
- data/lib/phrase/api/locale_downloads_api.rb +8 -8
- data/lib/phrase/api/locales_api.rb +17 -14
- data/lib/phrase/api/members_api.rb +10 -10
- data/lib/phrase/api/orders_api.rb +2 -2
- data/lib/phrase/api/release_triggers_api.rb +2 -2
- data/lib/phrase/api/search_api.rb +2 -2
- data/lib/phrase/api/tags_api.rb +3 -0
- data/lib/phrase/api/translations_api.rb +16 -16
- data/lib/phrase/models/distribution_create_parameters.rb +1 -1
- data/lib/phrase/models/distribution_update_parameters.rb +1 -1
- data/lib/phrase/models/invitation_create_parameters.rb +2 -2
- data/lib/phrase/models/job_annotation.rb +233 -0
- data/lib/phrase/models/job_annotation_short.rb +215 -0
- data/lib/phrase/models/job_annotation_update_parameters.rb +207 -0
- data/lib/phrase/models/job_details.rb +15 -4
- data/lib/phrase/models/job_locale.rb +15 -4
- data/lib/phrase/models/key_create_parameters.rb +11 -1
- data/lib/phrase/models/key_preview.rb +13 -4
- data/lib/phrase/models/key_update_parameters.rb +11 -1
- data/lib/phrase/models/keys_exclude_parameters.rb +1 -1
- data/lib/phrase/models/keys_include_parameters.rb +1 -1
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/keys_tag_parameters.rb +1 -1
- data/lib/phrase/models/keys_untag_parameters.rb +1 -1
- data/lib/phrase/models/locale.rb +12 -1
- data/lib/phrase/models/locale_create_parameters.rb +3 -3
- data/lib/phrase/models/locale_details.rb +12 -1
- data/lib/phrase/models/locale_download_create_parameters.rb +18 -8
- data/lib/phrase/models/locale_update_parameters.rb +3 -3
- data/lib/phrase/models/member_update_parameters.rb +1 -1
- data/lib/phrase/models/project_create_parameters.rb +4 -4
- data/lib/phrase/models/project_update_parameters.rb +5 -5
- data/lib/phrase/models/screenshot_marker_create_parameters.rb +1 -1
- data/lib/phrase/models/screenshot_marker_update_parameters.rb +1 -1
- data/lib/phrase/models/translation_create_parameters.rb +1 -1
- data/lib/phrase/models/translation_key.rb +10 -1
- data/lib/phrase/models/translation_key_details.rb +10 -1
- data/lib/phrase/models/translation_update_parameters.rb +1 -1
- data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
- data/lib/phrase/models/translations_include_parameters.rb +1 -1
- data/lib/phrase/models/translations_review_parameters.rb +1 -1
- data/lib/phrase/models/translations_search_parameters.rb +1 -1
- data/lib/phrase/models/translations_unreview_parameters.rb +1 -1
- data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
- data/lib/phrase/models/translations_verify_parameters.rb +1 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +4 -0
- data/spec/api/branches_api_spec.rb +3 -3
- data/spec/api/invitations_api_spec.rb +7 -7
- data/spec/api/job_annotations_api_spec.rb +120 -0
- data/spec/api/job_locales_api_spec.rb +2 -0
- data/spec/api/jobs_api_spec.rb +4 -3
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/locale_downloads_api_spec.rb +4 -4
- data/spec/api/members_api_spec.rb +5 -5
- data/spec/api/orders_api_spec.rb +1 -1
- data/spec/api/release_triggers_api_spec.rb +1 -1
- data/spec/api/search_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +1 -0
- data/spec/api/translations_api_spec.rb +8 -8
- data/spec/models/job_annotation_short_spec.rb +35 -0
- data/spec/models/job_annotation_spec.rb +47 -0
- data/spec/models/job_annotation_update_parameters_spec.rb +35 -0
- data/spec/models/job_details_spec.rb +6 -0
- data/spec/models/job_locale_spec.rb +6 -0
- data/spec/models/key_create_parameters_spec.rb +6 -0
- data/spec/models/key_preview_spec.rb +6 -0
- data/spec/models/key_update_parameters_spec.rb +6 -0
- data/spec/models/locale_details_spec.rb +6 -0
- data/spec/models/locale_download_create_parameters_spec.rb +6 -0
- data/spec/models/locale_spec.rb +6 -0
- data/spec/models/translation_key_details_spec.rb +6 -0
- data/spec/models/translation_key_spec.rb +6 -0
- metadata +247 -231
@@ -8,7 +8,7 @@ module Phrase
|
|
8
8
|
# Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project.
|
9
9
|
attr_accessor :key_id
|
10
10
|
|
11
|
-
# Presentation details of the screenshot marker in JSON format
|
11
|
+
# Presentation details of the screenshot marker in JSON format. Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (`x`-axis and `y`-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (`w` and `h` in pixels).
|
12
12
|
attr_accessor :presentation
|
13
13
|
|
14
14
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -17,7 +17,7 @@ module Phrase
|
|
17
17
|
# Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized.
|
18
18
|
attr_accessor :plural_suffix
|
19
19
|
|
20
|
-
# Indicates whether translation is unverified. Part of the
|
20
|
+
# Indicates whether translation is unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature.
|
21
21
|
attr_accessor :unverified
|
22
22
|
|
23
23
|
# Indicates whether translation is excluded.
|
@@ -12,6 +12,8 @@ module Phrase
|
|
12
12
|
|
13
13
|
attr_accessor :plural
|
14
14
|
|
15
|
+
attr_accessor :use_ordinal_rules
|
16
|
+
|
15
17
|
attr_accessor :tags
|
16
18
|
|
17
19
|
attr_accessor :data_type
|
@@ -28,6 +30,7 @@ module Phrase
|
|
28
30
|
:'description' => :'description',
|
29
31
|
:'name_hash' => :'name_hash',
|
30
32
|
:'plural' => :'plural',
|
33
|
+
:'use_ordinal_rules' => :'use_ordinal_rules',
|
31
34
|
:'tags' => :'tags',
|
32
35
|
:'data_type' => :'data_type',
|
33
36
|
:'created_at' => :'created_at',
|
@@ -43,6 +46,7 @@ module Phrase
|
|
43
46
|
:'description' => :'String',
|
44
47
|
:'name_hash' => :'String',
|
45
48
|
:'plural' => :'Boolean',
|
49
|
+
:'use_ordinal_rules' => :'Boolean',
|
46
50
|
:'tags' => :'Array<String>',
|
47
51
|
:'data_type' => :'String',
|
48
52
|
:'created_at' => :'DateTime',
|
@@ -91,6 +95,10 @@ module Phrase
|
|
91
95
|
self.plural = attributes[:'plural']
|
92
96
|
end
|
93
97
|
|
98
|
+
if attributes.key?(:'use_ordinal_rules')
|
99
|
+
self.use_ordinal_rules = attributes[:'use_ordinal_rules']
|
100
|
+
end
|
101
|
+
|
94
102
|
if attributes.key?(:'tags')
|
95
103
|
if (value = attributes[:'tags']).is_a?(Array)
|
96
104
|
self.tags = value
|
@@ -133,6 +141,7 @@ module Phrase
|
|
133
141
|
description == o.description &&
|
134
142
|
name_hash == o.name_hash &&
|
135
143
|
plural == o.plural &&
|
144
|
+
use_ordinal_rules == o.use_ordinal_rules &&
|
136
145
|
tags == o.tags &&
|
137
146
|
data_type == o.data_type &&
|
138
147
|
created_at == o.created_at &&
|
@@ -148,7 +157,7 @@ module Phrase
|
|
148
157
|
# Calculates hash code according to all attributes.
|
149
158
|
# @return [Integer] Hash code
|
150
159
|
def hash
|
151
|
-
[id, name, description, name_hash, plural, tags, data_type, created_at, updated_at].hash
|
160
|
+
[id, name, description, name_hash, plural, use_ordinal_rules, tags, data_type, created_at, updated_at].hash
|
152
161
|
end
|
153
162
|
|
154
163
|
# Builds the object from hash
|
@@ -12,6 +12,8 @@ module Phrase
|
|
12
12
|
|
13
13
|
attr_accessor :plural
|
14
14
|
|
15
|
+
attr_accessor :use_ordinal_rules
|
16
|
+
|
15
17
|
attr_accessor :tags
|
16
18
|
|
17
19
|
attr_accessor :data_type
|
@@ -48,6 +50,7 @@ module Phrase
|
|
48
50
|
:'description' => :'description',
|
49
51
|
:'name_hash' => :'name_hash',
|
50
52
|
:'plural' => :'plural',
|
53
|
+
:'use_ordinal_rules' => :'use_ordinal_rules',
|
51
54
|
:'tags' => :'tags',
|
52
55
|
:'data_type' => :'data_type',
|
53
56
|
:'created_at' => :'created_at',
|
@@ -73,6 +76,7 @@ module Phrase
|
|
73
76
|
:'description' => :'String',
|
74
77
|
:'name_hash' => :'String',
|
75
78
|
:'plural' => :'Boolean',
|
79
|
+
:'use_ordinal_rules' => :'Boolean',
|
76
80
|
:'tags' => :'Array<String>',
|
77
81
|
:'data_type' => :'String',
|
78
82
|
:'created_at' => :'DateTime',
|
@@ -138,6 +142,10 @@ module Phrase
|
|
138
142
|
self.plural = attributes[:'plural']
|
139
143
|
end
|
140
144
|
|
145
|
+
if attributes.key?(:'use_ordinal_rules')
|
146
|
+
self.use_ordinal_rules = attributes[:'use_ordinal_rules']
|
147
|
+
end
|
148
|
+
|
141
149
|
if attributes.key?(:'tags')
|
142
150
|
if (value = attributes[:'tags']).is_a?(Array)
|
143
151
|
self.tags = value
|
@@ -222,6 +230,7 @@ module Phrase
|
|
222
230
|
description == o.description &&
|
223
231
|
name_hash == o.name_hash &&
|
224
232
|
plural == o.plural &&
|
233
|
+
use_ordinal_rules == o.use_ordinal_rules &&
|
225
234
|
tags == o.tags &&
|
226
235
|
data_type == o.data_type &&
|
227
236
|
created_at == o.created_at &&
|
@@ -247,7 +256,7 @@ module Phrase
|
|
247
256
|
# Calculates hash code according to all attributes.
|
248
257
|
# @return [Integer] Hash code
|
249
258
|
def hash
|
250
|
-
[id, name, description, name_hash, plural, tags, data_type, created_at, updated_at, name_plural, comments_count, max_characters_allowed, screenshot_url, unformatted, xml_space_preserve, original_file, format_value_type, creator, custom_metadata].hash
|
259
|
+
[id, name, description, name_hash, plural, use_ordinal_rules, tags, data_type, created_at, updated_at, name_plural, comments_count, max_characters_allowed, screenshot_url, unformatted, xml_space_preserve, original_file, format_value_type, creator, custom_metadata].hash
|
251
260
|
end
|
252
261
|
|
253
262
|
# Builds the object from hash
|
@@ -11,7 +11,7 @@ module Phrase
|
|
11
11
|
# Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized.
|
12
12
|
attr_accessor :plural_suffix
|
13
13
|
|
14
|
-
# Indicates whether translation is unverified. Part of the
|
14
|
+
# Indicates whether translation is unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature.
|
15
15
|
attr_accessor :unverified
|
16
16
|
|
17
17
|
# Indicates whether translation is excluded.
|
@@ -5,7 +5,7 @@ module Phrase
|
|
5
5
|
# specify the branch to use
|
6
6
|
attr_accessor :branch
|
7
7
|
|
8
|
-
# Specify a query to find translations by content (including wildcards)
|
8
|
+
# Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
9
9
|
attr_accessor :q
|
10
10
|
|
11
11
|
# Sort criteria. Can be one of: key_name, created_at, updated_at.
|
@@ -5,7 +5,7 @@ module Phrase
|
|
5
5
|
# specify the branch to use
|
6
6
|
attr_accessor :branch
|
7
7
|
|
8
|
-
# Specify a query to find translations by content (including wildcards)
|
8
|
+
# Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: - `id:translation_id,...` for queries on a comma-separated list of ids - `tags:XYZ` for tags on the translation - `unverified:{true|false}` for verification status - `excluded:{true|false}` for exclusion status - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
9
9
|
attr_accessor :q
|
10
10
|
|
11
11
|
# Sort criteria. Can be one of: key_name, created_at, updated_at.
|
@@ -5,7 +5,7 @@ module Phrase
|
|
5
5
|
# specify the branch to use
|
6
6
|
attr_accessor :branch
|
7
7
|
|
8
|
-
# Specify a query to find translations by content (including wildcards)
|
8
|
+
# Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
9
9
|
attr_accessor :q
|
10
10
|
|
11
11
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -11,7 +11,7 @@ module Phrase
|
|
11
11
|
# Order direction. Can be one of: asc, desc.
|
12
12
|
attr_accessor :order
|
13
13
|
|
14
|
-
# Specify a query to find translations by content (including wildcards)
|
14
|
+
# Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: - `id:translation_id,...` for queries on a comma-separated list of ids - `tags:XYZ` for tags on the translation - `unverified:{true|false}` for verification status - `excluded:{true|false}` for exclusion status - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
15
15
|
attr_accessor :q
|
16
16
|
|
17
17
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -5,7 +5,7 @@ module Phrase
|
|
5
5
|
# specify the branch to use
|
6
6
|
attr_accessor :branch
|
7
7
|
|
8
|
-
# Specify a query to find translations by content (including wildcards)
|
8
|
+
# Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
9
9
|
attr_accessor :q
|
10
10
|
|
11
11
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -5,7 +5,7 @@ module Phrase
|
|
5
5
|
# specify the branch to use
|
6
6
|
attr_accessor :branch
|
7
7
|
|
8
|
-
# Specify a query to find translations by content (including wildcards)
|
8
|
+
# Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
9
9
|
attr_accessor :q
|
10
10
|
|
11
11
|
# Sort criteria. Can be one of: key_name, created_at, updated_at.
|
@@ -8,7 +8,7 @@ module Phrase
|
|
8
8
|
# specify the locale of the translations to be verified
|
9
9
|
attr_accessor :locale_id
|
10
10
|
|
11
|
-
# Specify a query to find translations by content (including wildcards)
|
11
|
+
# Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries Find more examples [here](/en/api/strings/usage-examples).
|
12
12
|
attr_accessor :q
|
13
13
|
|
14
14
|
# Attribute mapping from ruby-style variable name to JSON key.
|
data/lib/phrase/version.rb
CHANGED
data/lib/phrase.rb
CHANGED
@@ -65,6 +65,9 @@ require 'phrase/models/invitation_create_parameters'
|
|
65
65
|
require 'phrase/models/invitation_update_parameters'
|
66
66
|
require 'phrase/models/invitation_update_settings_parameters'
|
67
67
|
require 'phrase/models/job'
|
68
|
+
require 'phrase/models/job_annotation'
|
69
|
+
require 'phrase/models/job_annotation_short'
|
70
|
+
require 'phrase/models/job_annotation_update_parameters'
|
68
71
|
require 'phrase/models/job_comment'
|
69
72
|
require 'phrase/models/job_comment_create_parameters'
|
70
73
|
require 'phrase/models/job_comment_update_parameters'
|
@@ -239,6 +242,7 @@ require 'phrase/api/glossary_term_translations_api'
|
|
239
242
|
require 'phrase/api/glossary_terms_api'
|
240
243
|
require 'phrase/api/icu_api'
|
241
244
|
require 'phrase/api/invitations_api'
|
245
|
+
require 'phrase/api/job_annotations_api'
|
242
246
|
require 'phrase/api/job_comments_api'
|
243
247
|
require 'phrase/api/job_locales_api'
|
244
248
|
require 'phrase/api/job_template_locales_api'
|
@@ -22,7 +22,7 @@ describe 'BranchesApi' do
|
|
22
22
|
|
23
23
|
# unit tests for branch_compare
|
24
24
|
# Compare branches
|
25
|
-
# Compare branch with main branch.
|
25
|
+
# Compare branch with main branch. *Note: Comparing a branch may take several minutes depending on the project size.*
|
26
26
|
# @param project_id Project ID
|
27
27
|
# @param name name
|
28
28
|
# @param [Hash] opts the optional parameters
|
@@ -36,7 +36,7 @@ describe 'BranchesApi' do
|
|
36
36
|
|
37
37
|
# unit tests for branch_create
|
38
38
|
# Create a branch
|
39
|
-
# Create a new branch.
|
39
|
+
# Create a new branch. *Note: Creating a new branch may take several minutes depending on the project size.*
|
40
40
|
# @param project_id Project ID
|
41
41
|
# @param branch_create_parameters
|
42
42
|
# @param [Hash] opts the optional parameters
|
@@ -64,7 +64,7 @@ describe 'BranchesApi' do
|
|
64
64
|
|
65
65
|
# unit tests for branch_merge
|
66
66
|
# Merge a branch
|
67
|
-
# Merge an existing branch.
|
67
|
+
# Merge an existing branch. *Note: Merging a branch may take several minutes depending on diff size.*
|
68
68
|
# @param project_id Project ID
|
69
69
|
# @param name name
|
70
70
|
# @param branch_merge_parameters
|
@@ -22,7 +22,7 @@ describe 'InvitationsApi' do
|
|
22
22
|
|
23
23
|
# unit tests for invitation_create
|
24
24
|
# Create a new invitation
|
25
|
-
# Invite a person to an account. Developers and translators need
|
25
|
+
# 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`.
|
26
26
|
# @param account_id Account ID
|
27
27
|
# @param invitation_create_parameters
|
28
28
|
# @param [Hash] opts the optional parameters
|
@@ -36,7 +36,7 @@ describe 'InvitationsApi' do
|
|
36
36
|
|
37
37
|
# unit tests for invitation_delete
|
38
38
|
# Delete an invitation
|
39
|
-
# Delete an existing invitation (must not be accepted yet). Access token scope must include
|
39
|
+
# Delete an existing invitation (must not be accepted yet). 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 'InvitationsApi' do
|
|
50
50
|
|
51
51
|
# unit tests for invitation_resend
|
52
52
|
# Resend an invitation
|
53
|
-
# Resend the invitation email (must not be accepted yet). Access token scope must include
|
53
|
+
# Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`.
|
54
54
|
# @param account_id Account ID
|
55
55
|
# @param id ID
|
56
56
|
# @param [Hash] opts the optional parameters
|
@@ -64,7 +64,7 @@ describe 'InvitationsApi' do
|
|
64
64
|
|
65
65
|
# unit tests for invitation_show
|
66
66
|
# Get a single invitation
|
67
|
-
# Get details on a single invitation. Access token scope must include
|
67
|
+
# Get details on a single invitation. Access token scope must include `team.manage`.
|
68
68
|
# @param account_id Account ID
|
69
69
|
# @param id ID
|
70
70
|
# @param [Hash] opts the optional parameters
|
@@ -78,7 +78,7 @@ describe 'InvitationsApi' do
|
|
78
78
|
|
79
79
|
# unit tests for invitation_update
|
80
80
|
# Update an invitation
|
81
|
-
# Update an existing invitation (must not be accepted yet). The
|
81
|
+
# 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`.
|
82
82
|
# @param account_id Account ID
|
83
83
|
# @param id ID
|
84
84
|
# @param invitation_update_parameters
|
@@ -93,7 +93,7 @@ describe 'InvitationsApi' do
|
|
93
93
|
|
94
94
|
# unit tests for invitation_update_settings
|
95
95
|
# Update a member's invitation access
|
96
|
-
# Update member's settings in the invitations. Access token scope must include
|
96
|
+
# Update member's settings in the invitations. Access token scope must include `team.manage`.
|
97
97
|
# @param project_id Project ID
|
98
98
|
# @param id ID
|
99
99
|
# @param invitation_update_settings_parameters
|
@@ -108,7 +108,7 @@ describe 'InvitationsApi' do
|
|
108
108
|
|
109
109
|
# unit tests for invitations_list
|
110
110
|
# List invitations
|
111
|
-
# 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
|
111
|
+
# 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`.
|
112
112
|
# @param account_id Account ID
|
113
113
|
# @param [Hash] opts the optional parameters
|
114
114
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
@@ -0,0 +1,120 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
require 'json'
|
3
|
+
|
4
|
+
# Unit tests for Phrase::JobAnnotationsApi
|
5
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
6
|
+
# Please update as you see appropriate
|
7
|
+
describe 'JobAnnotationsApi' do
|
8
|
+
before do
|
9
|
+
# run before each test
|
10
|
+
@api_instance = Phrase::JobAnnotationsApi.new
|
11
|
+
end
|
12
|
+
|
13
|
+
after do
|
14
|
+
# run after each test
|
15
|
+
end
|
16
|
+
|
17
|
+
describe 'test an instance of JobAnnotationsApi' do
|
18
|
+
it 'should create an instance of JobAnnotationsApi' do
|
19
|
+
expect(@api_instance).to be_instance_of(Phrase::JobAnnotationsApi)
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
# unit tests for job_annotation_delete
|
24
|
+
# Delete a job annotation
|
25
|
+
# Delete an annotation for a job.
|
26
|
+
# @param project_id Project ID
|
27
|
+
# @param job_id Job ID
|
28
|
+
# @param id Name of the annotation to delete.
|
29
|
+
# @param [Hash] opts the optional parameters
|
30
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
31
|
+
# @option opts [String] :branch Branch to use
|
32
|
+
# @return [nil]
|
33
|
+
describe 'job_annotation_delete test' do
|
34
|
+
it 'should work' do
|
35
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
# unit tests for job_annotation_update
|
40
|
+
# Create/Update a job annotation
|
41
|
+
# Create or update an annotation for a job. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.
|
42
|
+
# @param project_id Project ID
|
43
|
+
# @param job_id Job ID
|
44
|
+
# @param id Name of the annotation to set or update.
|
45
|
+
# @param job_annotation_update_parameters
|
46
|
+
# @param [Hash] opts the optional parameters
|
47
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
48
|
+
# @return [JobAnnotation]
|
49
|
+
describe 'job_annotation_update test' do
|
50
|
+
it 'should work' do
|
51
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
# unit tests for job_annotations_list
|
56
|
+
# List job annotations
|
57
|
+
# Retrieve a list of annotations for a job.
|
58
|
+
# @param project_id Project ID
|
59
|
+
# @param job_id Job ID
|
60
|
+
# @param [Hash] opts the optional parameters
|
61
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
62
|
+
# @option opts [String] :branch Branch to use
|
63
|
+
# @return [Array<JobAnnotation>]
|
64
|
+
describe 'job_annotations_list test' do
|
65
|
+
it 'should work' do
|
66
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
# unit tests for job_locale_annotation_delete
|
71
|
+
# Delete a job locale annotation
|
72
|
+
# Delete an annotation for a job locale.
|
73
|
+
# @param project_id Project ID
|
74
|
+
# @param job_id Job ID
|
75
|
+
# @param job_locale_id Job Locale ID
|
76
|
+
# @param id Name of the annotation to delete.
|
77
|
+
# @param [Hash] opts the optional parameters
|
78
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
79
|
+
# @option opts [String] :branch Branch to use
|
80
|
+
# @return [nil]
|
81
|
+
describe 'job_locale_annotation_delete test' do
|
82
|
+
it 'should work' do
|
83
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
# unit tests for job_locale_annotation_update
|
88
|
+
# Create/Update a job locale annotation
|
89
|
+
# Create or update an annotation for a job locale. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.
|
90
|
+
# @param project_id Project ID
|
91
|
+
# @param job_id Job ID
|
92
|
+
# @param job_locale_id Job Locale ID
|
93
|
+
# @param id Name of the annotation to set or update.
|
94
|
+
# @param job_annotation_update_parameters
|
95
|
+
# @param [Hash] opts the optional parameters
|
96
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
97
|
+
# @return [JobAnnotation]
|
98
|
+
describe 'job_locale_annotation_update test' do
|
99
|
+
it 'should work' do
|
100
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
# unit tests for job_locale_annotations_list
|
105
|
+
# List job locale annotations
|
106
|
+
# Retrieve a list of annotations for a job locale.
|
107
|
+
# @param project_id Project ID
|
108
|
+
# @param job_id Job ID
|
109
|
+
# @param job_locale_id Job Locale ID
|
110
|
+
# @param [Hash] opts the optional parameters
|
111
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
112
|
+
# @option opts [String] :branch Branch to use
|
113
|
+
# @return [Array<JobAnnotation>]
|
114
|
+
describe 'job_locale_annotations_list test' do
|
115
|
+
it 'should work' do
|
116
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
120
|
+
end
|
@@ -93,6 +93,7 @@ describe 'JobLocalesApi' do
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
94
94
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
95
95
|
# @option opts [String] :branch Branch to use
|
96
|
+
# @option opts [Boolean] :include_annotations Include job-locale annotations in the response
|
96
97
|
# @return [JobLocale]
|
97
98
|
describe 'job_locale_show test' do
|
98
99
|
it 'should work' do
|
@@ -141,6 +142,7 @@ describe 'JobLocalesApi' do
|
|
141
142
|
# @option opts [Integer] :page Page number
|
142
143
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
143
144
|
# @option opts [String] :branch Branch to use
|
145
|
+
# @option opts [Boolean] :include_annotations Include job-locale annotations in the response
|
144
146
|
# @return [Array<JobLocale>]
|
145
147
|
describe 'job_locales_list test' do
|
146
148
|
it 'should work' do
|
data/spec/api/jobs_api_spec.rb
CHANGED
@@ -131,7 +131,8 @@ describe 'JobsApi' do
|
|
131
131
|
# @param id ID
|
132
132
|
# @param [Hash] opts the optional parameters
|
133
133
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
134
|
-
# @option opts [String] :branch
|
134
|
+
# @option opts [String] :branch Branch to use
|
135
|
+
# @option opts [Boolean] :include_annotations Include job-locale annotations in the response
|
135
136
|
# @return [JobDetails]
|
136
137
|
describe 'job_show test' do
|
137
138
|
it 'should work' do
|
@@ -194,7 +195,7 @@ describe 'JobsApi' do
|
|
194
195
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
195
196
|
# @option opts [String] :owned_by filter by user owning job
|
196
197
|
# @option opts [String] :assigned_to filter by user assigned to job
|
197
|
-
# @option opts [String] :state filter by state of job; valid states are:
|
198
|
+
# @option opts [String] :state filter by state of job; valid states are: `draft`, `in_progress`, `completed`
|
198
199
|
# @option opts [String] :updated_since filter by jobs updated since given date
|
199
200
|
# @return [Array<Job>]
|
200
201
|
describe 'jobs_by_account test' do
|
@@ -214,7 +215,7 @@ describe 'JobsApi' do
|
|
214
215
|
# @option opts [String] :branch Branch to use
|
215
216
|
# @option opts [String] :owned_by filter by user owning job
|
216
217
|
# @option opts [String] :assigned_to filter by user assigned to job
|
217
|
-
# @option opts [String] :state filter by state of job; valid states are:
|
218
|
+
# @option opts [String] :state filter by state of job; valid states are: `draft`, `in_progress`, `completed`
|
218
219
|
# @option opts [String] :updated_since filter by jobs updated since given date
|
219
220
|
# @return [Array<Job>]
|
220
221
|
describe 'jobs_list test' do
|
data/spec/api/keys_api_spec.rb
CHANGED
@@ -86,7 +86,7 @@ describe 'KeysApi' do
|
|
86
86
|
# @param [Hash] opts the optional parameters
|
87
87
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
88
88
|
# @option opts [String] :branch specify the branch to use
|
89
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards)
|
89
|
+
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term: - `ids:key_id,...` for queries on a comma-separated list of ids - `name:key_name` for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples).
|
90
90
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
91
91
|
# @return [AffectedResources]
|
92
92
|
describe 'keys_delete_collection test' do
|
@@ -134,7 +134,7 @@ describe 'KeysApi' do
|
|
134
134
|
# @option opts [String] :branch specify the branch to use
|
135
135
|
# @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
|
136
136
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
137
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards)
|
137
|
+
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards). The following qualifiers are also supported in the search term: - `ids:key_id,...` for queries on a comma-separated list of ids - `name:key_name` for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples).
|
138
138
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
139
139
|
# @return [Array<TranslationKey>]
|
140
140
|
describe 'keys_list test' do
|
@@ -28,8 +28,8 @@ describe 'LocaleDownloadsApi' do
|
|
28
28
|
# @param locale_download_create_parameters
|
29
29
|
# @param [Hash] opts the optional parameters
|
30
30
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
31
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
32
|
-
# @option opts [String] :if_none_match ETag condition, see
|
31
|
+
# @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)
|
32
|
+
# @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)
|
33
33
|
# @return [LocaleDownload]
|
34
34
|
describe 'locale_download_create test' do
|
35
35
|
it 'should work' do
|
@@ -45,8 +45,8 @@ describe 'LocaleDownloadsApi' do
|
|
45
45
|
# @param id ID
|
46
46
|
# @param [Hash] opts the optional parameters
|
47
47
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
48
|
-
# @option opts [String] :if_modified_since Last modified condition, see
|
49
|
-
# @option opts [String] :if_none_match ETag condition, see
|
48
|
+
# @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)
|
49
|
+
# @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)
|
50
50
|
# @return [LocaleDownload]
|
51
51
|
describe 'locale_download_show test' do
|
52
52
|
it 'should work' do
|
@@ -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
|