phrase 4.4.0 → 4.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +30 -0
  3. data/README.md +7 -5
  4. data/docs/BranchesApi.md +3 -3
  5. data/docs/CommentRepliesApi.md +3 -5
  6. data/docs/CommentsApi.md +3 -5
  7. data/docs/DistributionCreateParameters.md +1 -1
  8. data/docs/DistributionUpdateParameters.md +1 -1
  9. data/docs/InvitationCreateParameters.md +2 -2
  10. data/docs/InvitationsApi.md +7 -7
  11. data/docs/JobsApi.md +4 -4
  12. data/docs/KeyCreateParameters.md +3 -1
  13. data/docs/KeyPreview.md +3 -1
  14. data/docs/KeyUpdateParameters.md +3 -1
  15. data/docs/KeysApi.md +4 -4
  16. data/docs/KeysExcludeParameters.md +1 -1
  17. data/docs/KeysIncludeParameters.md +1 -1
  18. data/docs/KeysSearchParameters.md +1 -1
  19. data/docs/KeysTagParameters.md +1 -1
  20. data/docs/KeysUntagParameters.md +1 -1
  21. data/docs/Locale.md +2 -0
  22. data/docs/LocaleCreateParameters.md +3 -3
  23. data/docs/LocaleDetails.md +2 -0
  24. data/docs/LocaleDownloadCreateParameters.md +7 -5
  25. data/docs/LocaleDownloadsApi.md +8 -8
  26. data/docs/LocaleUpdateParameters.md +3 -3
  27. data/docs/LocalesApi.md +17 -15
  28. data/docs/MemberUpdateParameters.md +1 -1
  29. data/docs/MembersApi.md +5 -5
  30. data/docs/OrdersApi.md +1 -1
  31. data/docs/ProjectCreateParameters.md +5 -5
  32. data/docs/ProjectUpdateParameters.md +6 -6
  33. data/docs/ReleaseTriggersApi.md +1 -1
  34. data/docs/ScreenshotMarkerCreateParameters.md +1 -1
  35. data/docs/ScreenshotMarkerUpdateParameters.md +1 -1
  36. data/docs/ScreenshotUpdateParameters.md +1 -1
  37. data/docs/SearchApi.md +1 -1
  38. data/docs/TagsApi.md +2 -0
  39. data/docs/TranslationCreateParameters.md +1 -1
  40. data/docs/TranslationKey.md +2 -0
  41. data/docs/TranslationKeyDetails.md +2 -0
  42. data/docs/TranslationUnreviewParameters.md +17 -0
  43. data/docs/TranslationUpdateParameters.md +1 -1
  44. data/docs/TranslationsApi.md +143 -13
  45. data/docs/TranslationsExcludeParameters.md +1 -1
  46. data/docs/TranslationsIncludeParameters.md +1 -1
  47. data/docs/TranslationsReviewParameters.md +1 -1
  48. data/docs/TranslationsSearchParameters.md +1 -1
  49. data/docs/TranslationsUnreviewParameters.md +19 -0
  50. data/docs/TranslationsUnverifyParameters.md +1 -1
  51. data/docs/TranslationsVerifyParameters.md +1 -1
  52. data/docs/UploadSummary.md +5 -1
  53. data/docs/UploadsApi.md +2 -0
  54. data/lib/phrase/api/branches_api.rb +6 -6
  55. data/lib/phrase/api/comment_replies_api.rb +4 -12
  56. data/lib/phrase/api/comments_api.rb +4 -12
  57. data/lib/phrase/api/invitations_api.rb +14 -14
  58. data/lib/phrase/api/jobs_api.rb +4 -4
  59. data/lib/phrase/api/keys_api.rb +4 -4
  60. data/lib/phrase/api/locale_downloads_api.rb +8 -8
  61. data/lib/phrase/api/locales_api.rb +17 -14
  62. data/lib/phrase/api/members_api.rb +10 -10
  63. data/lib/phrase/api/orders_api.rb +2 -2
  64. data/lib/phrase/api/release_triggers_api.rb +2 -2
  65. data/lib/phrase/api/search_api.rb +2 -2
  66. data/lib/phrase/api/tags_api.rb +3 -0
  67. data/lib/phrase/api/translations_api.rb +170 -16
  68. data/lib/phrase/api/uploads_api.rb +3 -0
  69. data/lib/phrase/models/distribution_create_parameters.rb +1 -1
  70. data/lib/phrase/models/distribution_update_parameters.rb +1 -1
  71. data/lib/phrase/models/invitation_create_parameters.rb +2 -2
  72. data/lib/phrase/models/key_create_parameters.rb +11 -1
  73. data/lib/phrase/models/key_preview.rb +13 -4
  74. data/lib/phrase/models/key_update_parameters.rb +11 -1
  75. data/lib/phrase/models/keys_exclude_parameters.rb +1 -1
  76. data/lib/phrase/models/keys_include_parameters.rb +1 -1
  77. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  78. data/lib/phrase/models/keys_tag_parameters.rb +1 -1
  79. data/lib/phrase/models/keys_untag_parameters.rb +1 -1
  80. data/lib/phrase/models/locale.rb +12 -1
  81. data/lib/phrase/models/locale_create_parameters.rb +3 -3
  82. data/lib/phrase/models/locale_details.rb +12 -1
  83. data/lib/phrase/models/locale_download_create_parameters.rb +18 -8
  84. data/lib/phrase/models/locale_update_parameters.rb +3 -3
  85. data/lib/phrase/models/member_update_parameters.rb +1 -1
  86. data/lib/phrase/models/project_create_parameters.rb +4 -4
  87. data/lib/phrase/models/project_update_parameters.rb +5 -5
  88. data/lib/phrase/models/screenshot_marker_create_parameters.rb +1 -1
  89. data/lib/phrase/models/screenshot_marker_update_parameters.rb +1 -1
  90. data/lib/phrase/models/translation_create_parameters.rb +1 -1
  91. data/lib/phrase/models/translation_key.rb +10 -1
  92. data/lib/phrase/models/translation_key_details.rb +10 -1
  93. data/lib/phrase/models/{comments_list_parameters.rb → translation_unreview_parameters.rb} +8 -52
  94. data/lib/phrase/models/translation_update_parameters.rb +1 -1
  95. data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
  96. data/lib/phrase/models/translations_include_parameters.rb +1 -1
  97. data/lib/phrase/models/translations_review_parameters.rb +1 -1
  98. data/lib/phrase/models/translations_search_parameters.rb +1 -1
  99. data/lib/phrase/models/{replies_list_parameters.rb → translations_unreview_parameters.rb} +12 -34
  100. data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
  101. data/lib/phrase/models/translations_verify_parameters.rb +1 -1
  102. data/lib/phrase/models/upload_summary.rb +22 -4
  103. data/lib/phrase/version.rb +1 -1
  104. data/lib/phrase.rb +2 -2
  105. data/spec/api/branches_api_spec.rb +3 -3
  106. data/spec/api/comment_replies_api_spec.rb +0 -1
  107. data/spec/api/comments_api_spec.rb +0 -1
  108. data/spec/api/invitations_api_spec.rb +7 -7
  109. data/spec/api/jobs_api_spec.rb +2 -2
  110. data/spec/api/keys_api_spec.rb +2 -2
  111. data/spec/api/locale_downloads_api_spec.rb +4 -4
  112. data/spec/api/members_api_spec.rb +5 -5
  113. data/spec/api/orders_api_spec.rb +1 -1
  114. data/spec/api/release_triggers_api_spec.rb +1 -1
  115. data/spec/api/search_api_spec.rb +1 -1
  116. data/spec/api/tags_api_spec.rb +1 -0
  117. data/spec/api/translations_api_spec.rb +37 -8
  118. data/spec/models/key_create_parameters_spec.rb +6 -0
  119. data/spec/models/key_preview_spec.rb +6 -0
  120. data/spec/models/key_update_parameters_spec.rb +6 -0
  121. data/spec/models/locale_details_spec.rb +6 -0
  122. data/spec/models/locale_download_create_parameters_spec.rb +6 -0
  123. data/spec/models/locale_spec.rb +6 -0
  124. data/spec/models/translation_key_details_spec.rb +6 -0
  125. data/spec/models/translation_key_spec.rb +6 -0
  126. data/spec/models/translation_unreview_parameters_spec.rb +29 -0
  127. data/spec/models/translations_unreview_parameters_spec.rb +35 -0
  128. data/spec/models/upload_summary_spec.rb +12 -0
  129. metadata +236 -236
  130. data/docs/CommentsListParameters.md +0 -25
  131. data/docs/RepliesListParameters.md +0 -23
  132. data/spec/models/comments_list_parameters_spec.rb +0 -53
  133. data/spec/models/replies_list_parameters_spec.rb +0 -47
@@ -16,6 +16,8 @@ module Phrase
16
16
 
17
17
  attr_accessor :plural_forms
18
18
 
19
+ attr_accessor :ordinal_plural_forms
20
+
19
21
  attr_accessor :source_locale
20
22
 
21
23
  attr_accessor :fallback_locale
@@ -34,6 +36,7 @@ module Phrase
34
36
  :'main' => :'main',
35
37
  :'rtl' => :'rtl',
36
38
  :'plural_forms' => :'plural_forms',
39
+ :'ordinal_plural_forms' => :'ordinal_plural_forms',
37
40
  :'source_locale' => :'source_locale',
38
41
  :'fallback_locale' => :'fallback_locale',
39
42
  :'created_at' => :'created_at',
@@ -51,6 +54,7 @@ module Phrase
51
54
  :'main' => :'Boolean',
52
55
  :'rtl' => :'Boolean',
53
56
  :'plural_forms' => :'Array<String>',
57
+ :'ordinal_plural_forms' => :'Array<String>',
54
58
  :'source_locale' => :'LocalePreview',
55
59
  :'fallback_locale' => :'LocalePreview',
56
60
  :'created_at' => :'DateTime',
@@ -109,6 +113,12 @@ module Phrase
109
113
  end
110
114
  end
111
115
 
116
+ if attributes.key?(:'ordinal_plural_forms')
117
+ if (value = attributes[:'ordinal_plural_forms']).is_a?(Array)
118
+ self.ordinal_plural_forms = value
119
+ end
120
+ end
121
+
112
122
  if attributes.key?(:'source_locale')
113
123
  self.source_locale = attributes[:'source_locale']
114
124
  end
@@ -151,6 +161,7 @@ module Phrase
151
161
  main == o.main &&
152
162
  rtl == o.rtl &&
153
163
  plural_forms == o.plural_forms &&
164
+ ordinal_plural_forms == o.ordinal_plural_forms &&
154
165
  source_locale == o.source_locale &&
155
166
  fallback_locale == o.fallback_locale &&
156
167
  created_at == o.created_at &&
@@ -166,7 +177,7 @@ module Phrase
166
177
  # Calculates hash code according to all attributes.
167
178
  # @return [Integer] Hash code
168
179
  def hash
169
- [id, name, code, default, main, rtl, plural_forms, source_locale, fallback_locale, created_at, updated_at].hash
180
+ [id, name, code, default, main, rtl, plural_forms, ordinal_plural_forms, source_locale, fallback_locale, created_at, updated_at].hash
170
181
  end
171
182
 
172
183
  # 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 <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Verification System</a> feature.
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 <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
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 <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
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.
@@ -16,6 +16,8 @@ module Phrase
16
16
 
17
17
  attr_accessor :plural_forms
18
18
 
19
+ attr_accessor :ordinal_plural_forms
20
+
19
21
  attr_accessor :source_locale
20
22
 
21
23
  attr_accessor :fallback_locale
@@ -36,6 +38,7 @@ module Phrase
36
38
  :'main' => :'main',
37
39
  :'rtl' => :'rtl',
38
40
  :'plural_forms' => :'plural_forms',
41
+ :'ordinal_plural_forms' => :'ordinal_plural_forms',
39
42
  :'source_locale' => :'source_locale',
40
43
  :'fallback_locale' => :'fallback_locale',
41
44
  :'created_at' => :'created_at',
@@ -54,6 +57,7 @@ module Phrase
54
57
  :'main' => :'Boolean',
55
58
  :'rtl' => :'Boolean',
56
59
  :'plural_forms' => :'Array<String>',
60
+ :'ordinal_plural_forms' => :'Array<String>',
57
61
  :'source_locale' => :'LocalePreview',
58
62
  :'fallback_locale' => :'LocalePreview',
59
63
  :'created_at' => :'DateTime',
@@ -120,6 +124,12 @@ module Phrase
120
124
  end
121
125
  end
122
126
 
127
+ if attributes.key?(:'ordinal_plural_forms')
128
+ if (value = attributes[:'ordinal_plural_forms']).is_a?(Array)
129
+ self.ordinal_plural_forms = value
130
+ end
131
+ end
132
+
123
133
  if attributes.key?(:'source_locale')
124
134
  self.source_locale = attributes[:'source_locale']
125
135
  end
@@ -166,6 +176,7 @@ module Phrase
166
176
  main == o.main &&
167
177
  rtl == o.rtl &&
168
178
  plural_forms == o.plural_forms &&
179
+ ordinal_plural_forms == o.ordinal_plural_forms &&
169
180
  source_locale == o.source_locale &&
170
181
  fallback_locale == o.fallback_locale &&
171
182
  created_at == o.created_at &&
@@ -182,7 +193,7 @@ module Phrase
182
193
  # Calculates hash code according to all attributes.
183
194
  # @return [Integer] Hash code
184
195
  def hash
185
- [id, name, code, default, main, rtl, plural_forms, source_locale, fallback_locale, created_at, updated_at, statistics].hash
196
+ [id, name, code, default, main, rtl, plural_forms, ordinal_plural_forms, source_locale, fallback_locale, created_at, updated_at, statistics].hash
186
197
  end
187
198
 
188
199
  # Builds the object from hash
@@ -2,7 +2,7 @@ require 'date'
2
2
 
3
3
  module Phrase
4
4
  class LocaleDownloadCreateParameters
5
- # File format name. See the <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for all supported file formats.
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 <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
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 <code>true</code>.
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 <code>tag</code> parameter indicating a specific job.
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 <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Verification System</a> feature.
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 <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
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 <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
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 <code>create_upload</code> and <code>review_translations</code>
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 <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>.
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\". <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\">Read more</a>
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. <a href=\"https://support.phrase.com/hc/en-us/articles/5822319545116\">Read more</a>
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. <a href=\"https://support.phrase.com/hc/en-us/articles/5822187934364\">Read more</a>
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 <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>.
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\". <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\">Read more</a>
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. <a href=\"https://support.phrase.com/hc/en-us/articles/5822319545116\">Read more</a>
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. <a href=\"https://support.phrase.com/hc/en-us/articles/5822187934364\">Read more</a>
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 <a href='#post-/projects/-project_id-/uploads'>`file_encoding`</a> parameter for Uploads.
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.<br/><br/>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 (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels).
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.<br/><br/>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 (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels).
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 <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
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
@@ -1,41 +1,21 @@
1
1
  require 'date'
2
2
 
3
3
  module Phrase
4
- class CommentsListParameters
5
- # Specify the branch to use
4
+ class TranslationUnreviewParameters
5
+ # specify the branch to use
6
6
  attr_accessor :branch
7
7
 
8
- # Search query for comment messages
9
- attr_accessor :query
10
-
11
- # Search comments by their assigned locales
12
- attr_accessor :locale_ids
13
-
14
- # Specify filters to find comments by
15
- attr_accessor :filters
16
-
17
- # Specify ordering of comments
18
- attr_accessor :order
19
-
20
8
  # Attribute mapping from ruby-style variable name to JSON key.
21
9
  def self.attribute_map
22
10
  {
23
- :'branch' => :'branch',
24
- :'query' => :'query',
25
- :'locale_ids' => :'locale_ids',
26
- :'filters' => :'filters',
27
- :'order' => :'order'
11
+ :'branch' => :'branch'
28
12
  }
29
13
  end
30
14
 
31
15
  # Attribute type mapping.
32
16
  def self.openapi_types
33
17
  {
34
- :'branch' => :'String',
35
- :'query' => :'String',
36
- :'locale_ids' => :'Array<String>',
37
- :'filters' => :'Array<String>',
38
- :'order' => :'String'
18
+ :'branch' => :'String'
39
19
  }
40
20
  end
41
21
 
@@ -49,13 +29,13 @@ module Phrase
49
29
  # @param [Hash] attributes Model attributes in the form of hash
50
30
  def initialize(attributes = {})
51
31
  if (!attributes.is_a?(Hash))
52
- fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentsListParameters` initialize method"
32
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::TranslationUnreviewParameters` initialize method"
53
33
  end
54
34
 
55
35
  # check to see if the attribute exists and convert string to symbol for hash key
56
36
  attributes = attributes.each_with_object({}) { |(k, v), h|
57
37
  if (!self.class.attribute_map.key?(k.to_sym))
58
- fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentsListParameters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
38
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::TranslationUnreviewParameters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
59
39
  end
60
40
  h[k.to_sym] = v
61
41
  }
@@ -63,26 +43,6 @@ module Phrase
63
43
  if attributes.key?(:'branch')
64
44
  self.branch = attributes[:'branch']
65
45
  end
66
-
67
- if attributes.key?(:'query')
68
- self.query = attributes[:'query']
69
- end
70
-
71
- if attributes.key?(:'locale_ids')
72
- if (value = attributes[:'locale_ids']).is_a?(Array)
73
- self.locale_ids = value
74
- end
75
- end
76
-
77
- if attributes.key?(:'filters')
78
- if (value = attributes[:'filters']).is_a?(Array)
79
- self.filters = value
80
- end
81
- end
82
-
83
- if attributes.key?(:'order')
84
- self.order = attributes[:'order']
85
- end
86
46
  end
87
47
 
88
48
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -103,11 +63,7 @@ module Phrase
103
63
  def ==(o)
104
64
  return true if self.equal?(o)
105
65
  self.class == o.class &&
106
- branch == o.branch &&
107
- query == o.query &&
108
- locale_ids == o.locale_ids &&
109
- filters == o.filters &&
110
- order == o.order
66
+ branch == o.branch
111
67
  end
112
68
 
113
69
  # @see the `==` method
@@ -119,7 +75,7 @@ module Phrase
119
75
  # Calculates hash code according to all attributes.
120
76
  # @return [Integer] Hash code
121
77
  def hash
122
- [branch, query, locale_ids, filters, order].hash
78
+ [branch].hash
123
79
  end
124
80
 
125
81
  # 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 <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
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).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
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).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
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).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
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.