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
@@ -2,7 +2,7 @@ require 'date'
|
|
2
2
|
|
3
3
|
module Phrase
|
4
4
|
class LocaleDownloadCreateParameters
|
5
|
-
# File format name. See the
|
5
|
+
# File format name. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for all supported file formats.
|
6
6
|
attr_accessor :file_format
|
7
7
|
|
8
8
|
# specify the branch to use
|
@@ -23,7 +23,7 @@ module Phrase
|
|
23
23
|
# Indicates whether [NOTRANSLATE] tags should be kept.
|
24
24
|
attr_accessor :keep_notranslate_tags
|
25
25
|
|
26
|
-
# Additional formatting and render options. See the
|
26
|
+
# 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: `...&format_options[foo]=bar`
|
27
27
|
attr_accessor :format_options
|
28
28
|
|
29
29
|
# Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
|
@@ -38,15 +38,18 @@ module Phrase
|
|
38
38
|
# Locale IDs or locale names
|
39
39
|
attr_accessor :locale_ids
|
40
40
|
|
41
|
-
# 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
|
41
|
+
# 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 `true`.
|
42
42
|
attr_accessor :fallback_locale_id
|
43
43
|
|
44
|
-
# 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
|
44
|
+
# 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 `tag` parameter indicating a specific job.
|
45
45
|
attr_accessor :source_locale_id
|
46
46
|
|
47
47
|
# 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.
|
48
48
|
attr_accessor :custom_metadata_filters
|
49
49
|
|
50
|
+
# Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).
|
51
|
+
attr_accessor :updated_since
|
52
|
+
|
50
53
|
# Attribute mapping from ruby-style variable name to JSON key.
|
51
54
|
def self.attribute_map
|
52
55
|
{
|
@@ -64,7 +67,8 @@ module Phrase
|
|
64
67
|
:'locale_ids' => :'locale_ids',
|
65
68
|
:'fallback_locale_id' => :'fallback_locale_id',
|
66
69
|
:'source_locale_id' => :'source_locale_id',
|
67
|
-
:'custom_metadata_filters' => :'custom_metadata_filters'
|
70
|
+
:'custom_metadata_filters' => :'custom_metadata_filters',
|
71
|
+
:'updated_since' => :'updated_since'
|
68
72
|
}
|
69
73
|
end
|
70
74
|
|
@@ -85,7 +89,8 @@ module Phrase
|
|
85
89
|
:'locale_ids' => :'Array<String>',
|
86
90
|
:'fallback_locale_id' => :'String',
|
87
91
|
:'source_locale_id' => :'String',
|
88
|
-
:'custom_metadata_filters' => :'Object'
|
92
|
+
:'custom_metadata_filters' => :'Object',
|
93
|
+
:'updated_since' => :'String'
|
89
94
|
}
|
90
95
|
end
|
91
96
|
|
@@ -171,6 +176,10 @@ module Phrase
|
|
171
176
|
if attributes.key?(:'custom_metadata_filters')
|
172
177
|
self.custom_metadata_filters = attributes[:'custom_metadata_filters']
|
173
178
|
end
|
179
|
+
|
180
|
+
if attributes.key?(:'updated_since')
|
181
|
+
self.updated_since = attributes[:'updated_since']
|
182
|
+
end
|
174
183
|
end
|
175
184
|
|
176
185
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -210,7 +219,8 @@ module Phrase
|
|
210
219
|
locale_ids == o.locale_ids &&
|
211
220
|
fallback_locale_id == o.fallback_locale_id &&
|
212
221
|
source_locale_id == o.source_locale_id &&
|
213
|
-
custom_metadata_filters == o.custom_metadata_filters
|
222
|
+
custom_metadata_filters == o.custom_metadata_filters &&
|
223
|
+
updated_since == o.updated_since
|
214
224
|
end
|
215
225
|
|
216
226
|
# @see the `==` method
|
@@ -222,7 +232,7 @@ module Phrase
|
|
222
232
|
# Calculates hash code according to all attributes.
|
223
233
|
# @return [Integer] Hash code
|
224
234
|
def hash
|
225
|
-
[file_format, branch, tags, include_empty_translations, exclude_empty_zero_forms, include_translated_keys, keep_notranslate_tags, format_options, encoding, include_unverified_translations, use_last_reviewed_version, locale_ids, fallback_locale_id, source_locale_id, custom_metadata_filters].hash
|
235
|
+
[file_format, branch, tags, include_empty_translations, exclude_empty_zero_forms, include_translated_keys, keep_notranslate_tags, format_options, encoding, include_unverified_translations, use_last_reviewed_version, locale_ids, fallback_locale_id, source_locale_id, custom_metadata_filters, updated_since].hash
|
226
236
|
end
|
227
237
|
|
228
238
|
# Builds the object from hash
|
@@ -14,7 +14,7 @@ module Phrase
|
|
14
14
|
# Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale.
|
15
15
|
attr_accessor :default
|
16
16
|
|
17
|
-
# Indicates whether locale is a main locale. Main locales are part of the
|
17
|
+
# 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.
|
18
18
|
attr_accessor :main
|
19
19
|
|
20
20
|
# Indicates whether locale is a RTL (Right-to-Left) locale.
|
@@ -26,10 +26,10 @@ module Phrase
|
|
26
26
|
# Fallback locale for empty translations. Can be a locale name or id.
|
27
27
|
attr_accessor :fallback_locale_id
|
28
28
|
|
29
|
-
# Indicates that new translations for this locale should be marked as unverified. Part of the
|
29
|
+
# 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.
|
30
30
|
attr_accessor :unverify_new_translations
|
31
31
|
|
32
|
-
# Indicates that updated translations for this locale should be marked as unverified. Part of the
|
32
|
+
# 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.
|
33
33
|
attr_accessor :unverify_updated_translations
|
34
34
|
|
35
35
|
# If set, translations for this locale will be fetched automatically, right after creation.
|
@@ -20,7 +20,7 @@ module Phrase
|
|
20
20
|
# List of spaces the user is assigned to.
|
21
21
|
attr_accessor :space_ids
|
22
22
|
|
23
|
-
# Additional permissions depending on member role. Available permissions are
|
23
|
+
# Additional permissions depending on member role. Available permissions are `create_upload` and `review_translations`
|
24
24
|
attr_accessor :permissions
|
25
25
|
|
26
26
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -5,7 +5,7 @@ module Phrase
|
|
5
5
|
# Name of the project
|
6
6
|
attr_accessor :name
|
7
7
|
|
8
|
-
# Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see
|
8
|
+
# Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see [Format Guide](https://support.phrase.com/hc/en-us/sections/6111343326364) or our [Formats API Endpoint](/en/api/strings/formats/list-formats).
|
9
9
|
attr_accessor :main_format
|
10
10
|
|
11
11
|
# (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`, `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value.
|
@@ -29,7 +29,7 @@ module Phrase
|
|
29
29
|
# When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params.
|
30
30
|
attr_accessor :source_project_id
|
31
31
|
|
32
|
-
# (Optional) Review Workflow. \"simple\" / \"review\".
|
32
|
+
# (Optional) Review Workflow. \"simple\" / \"review\". [Read more](https://support.phrase.com/hc/en-us/articles/5784094755484)
|
33
33
|
attr_accessor :workflow
|
34
34
|
|
35
35
|
# (Optional) Enable machine translation support in the project. Required for Pre-Translation
|
@@ -44,13 +44,13 @@ module Phrase
|
|
44
44
|
# (Optional) Otherwise, translators are not allowed to edit translations other than strings
|
45
45
|
attr_accessor :enable_all_data_type_translation_keys_for_translators
|
46
46
|
|
47
|
-
# (Optional) We can validate and highlight your ICU messages.
|
47
|
+
# (Optional) We can validate and highlight your ICU messages. [Read more](https://support.phrase.com/hc/en-us/articles/5822319545116)
|
48
48
|
attr_accessor :enable_icu_message_format
|
49
49
|
|
50
50
|
# (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly.
|
51
51
|
attr_accessor :zero_plural_form_enabled
|
52
52
|
|
53
|
-
# (Optional) Autopilot, requires machine_translation_enabled.
|
53
|
+
# (Optional) Autopilot, requires machine_translation_enabled. [Read more](https://support.phrase.com/hc/en-us/articles/5822187934364)
|
54
54
|
attr_accessor :autotranslate_enabled
|
55
55
|
|
56
56
|
# (Optional) Requires autotranslate_enabled to be true
|
@@ -11,7 +11,7 @@ module Phrase
|
|
11
11
|
# (Optional) User ID of the point of contact for the project. Pass `null` to unset.
|
12
12
|
attr_accessor :point_of_contact
|
13
13
|
|
14
|
-
# (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see
|
14
|
+
# (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see [Format Guide](https://support.phrase.com/hc/en-us/sections/6111343326364) or our [Formats API Endpoint](#formats).
|
15
15
|
attr_accessor :main_format
|
16
16
|
|
17
17
|
# (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`, `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value.
|
@@ -26,7 +26,7 @@ module Phrase
|
|
26
26
|
# (Optional) Indicates whether the project image should be deleted.
|
27
27
|
attr_accessor :remove_project_image
|
28
28
|
|
29
|
-
# (Optional) Review Workflow. \"simple\" / \"review\".
|
29
|
+
# (Optional) Review Workflow. \"simple\" / \"review\". [Read more](https://support.phrase.com/hc/en-us/articles/5784094755484)
|
30
30
|
attr_accessor :workflow
|
31
31
|
|
32
32
|
# (Optional) Enable machine translation support in the project. Required for Pre-Translation
|
@@ -41,13 +41,13 @@ module Phrase
|
|
41
41
|
# (Optional) Otherwise, translators are not allowed to edit translations other than strings
|
42
42
|
attr_accessor :enable_all_data_type_translation_keys_for_translators
|
43
43
|
|
44
|
-
# (Optional) We can validate and highlight your ICU messages.
|
44
|
+
# (Optional) We can validate and highlight your ICU messages. [Read more](https://support.phrase.com/hc/en-us/articles/5822319545116)
|
45
45
|
attr_accessor :enable_icu_message_format
|
46
46
|
|
47
47
|
# (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly.
|
48
48
|
attr_accessor :zero_plural_form_enabled
|
49
49
|
|
50
|
-
# (Optional) Autopilot, requires machine_translation_enabled.
|
50
|
+
# (Optional) Autopilot, requires machine_translation_enabled. [Read more](https://support.phrase.com/hc/en-us/articles/5822187934364)
|
51
51
|
attr_accessor :autotranslate_enabled
|
52
52
|
|
53
53
|
# (Optional) Requires autotranslate_enabled to be true
|
@@ -68,7 +68,7 @@ module Phrase
|
|
68
68
|
# (Optional) Requires autotranslate_enabled to be true
|
69
69
|
attr_accessor :autotranslate_use_translation_memory
|
70
70
|
|
71
|
-
# (Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the
|
71
|
+
# (Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the [`file_encoding`](/en/api/strings/uploads/upload-a-new-file) parameter for Uploads.
|
72
72
|
attr_accessor :default_encoding
|
73
73
|
|
74
74
|
class EnumAttributeValidator
|
@@ -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.
|
@@ -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
@@ -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)
|
data/spec/api/jobs_api_spec.rb
CHANGED
@@ -194,7 +194,7 @@ describe 'JobsApi' do
|
|
194
194
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
195
195
|
# @option opts [String] :owned_by filter by user owning job
|
196
196
|
# @option opts [String] :assigned_to filter by user assigned to job
|
197
|
-
# @option opts [String] :state filter by state of job; valid states are:
|
197
|
+
# @option opts [String] :state filter by state of job; valid states are: `draft`, `in_progress`, `completed`
|
198
198
|
# @option opts [String] :updated_since filter by jobs updated since given date
|
199
199
|
# @return [Array<Job>]
|
200
200
|
describe 'jobs_by_account test' do
|
@@ -214,7 +214,7 @@ describe 'JobsApi' do
|
|
214
214
|
# @option opts [String] :branch Branch to use
|
215
215
|
# @option opts [String] :owned_by filter by user owning job
|
216
216
|
# @option opts [String] :assigned_to filter by user assigned to job
|
217
|
-
# @option opts [String] :state filter by state of job; valid states are:
|
217
|
+
# @option opts [String] :state filter by state of job; valid states are: `draft`, `in_progress`, `completed`
|
218
218
|
# @option opts [String] :updated_since filter by jobs updated since given date
|
219
219
|
# @return [Array<Job>]
|
220
220
|
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
|