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
@@ -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).<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>.
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.
@@ -1,26 +1,18 @@
1
1
  require 'date'
2
2
 
3
3
  module Phrase
4
- class RepliesListParameters
5
- # Specify the branch to use
4
+ class TranslationsUnreviewParameters
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
- # Specify filters to find comments by
12
- attr_accessor :filters
13
-
14
- # Specify ordering of comments
15
- attr_accessor :order
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
+ attr_accessor :q
16
10
 
17
11
  # Attribute mapping from ruby-style variable name to JSON key.
18
12
  def self.attribute_map
19
13
  {
20
14
  :'branch' => :'branch',
21
- :'query' => :'query',
22
- :'filters' => :'filters',
23
- :'order' => :'order'
15
+ :'q' => :'q'
24
16
  }
25
17
  end
26
18
 
@@ -28,9 +20,7 @@ module Phrase
28
20
  def self.openapi_types
29
21
  {
30
22
  :'branch' => :'String',
31
- :'query' => :'String',
32
- :'filters' => :'Array<String>',
33
- :'order' => :'String'
23
+ :'q' => :'String'
34
24
  }
35
25
  end
36
26
 
@@ -44,13 +34,13 @@ module Phrase
44
34
  # @param [Hash] attributes Model attributes in the form of hash
45
35
  def initialize(attributes = {})
46
36
  if (!attributes.is_a?(Hash))
47
- fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::RepliesListParameters` initialize method"
37
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::TranslationsUnreviewParameters` initialize method"
48
38
  end
49
39
 
50
40
  # check to see if the attribute exists and convert string to symbol for hash key
51
41
  attributes = attributes.each_with_object({}) { |(k, v), h|
52
42
  if (!self.class.attribute_map.key?(k.to_sym))
53
- fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::RepliesListParameters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
43
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::TranslationsUnreviewParameters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
54
44
  end
55
45
  h[k.to_sym] = v
56
46
  }
@@ -59,18 +49,8 @@ module Phrase
59
49
  self.branch = attributes[:'branch']
60
50
  end
61
51
 
62
- if attributes.key?(:'query')
63
- self.query = attributes[:'query']
64
- end
65
-
66
- if attributes.key?(:'filters')
67
- if (value = attributes[:'filters']).is_a?(Array)
68
- self.filters = value
69
- end
70
- end
71
-
72
- if attributes.key?(:'order')
73
- self.order = attributes[:'order']
52
+ if attributes.key?(:'q')
53
+ self.q = attributes[:'q']
74
54
  end
75
55
  end
76
56
 
@@ -93,9 +73,7 @@ module Phrase
93
73
  return true if self.equal?(o)
94
74
  self.class == o.class &&
95
75
  branch == o.branch &&
96
- query == o.query &&
97
- filters == o.filters &&
98
- order == o.order
76
+ q == o.q
99
77
  end
100
78
 
101
79
  # @see the `==` method
@@ -107,7 +85,7 @@ module Phrase
107
85
  # Calculates hash code according to all attributes.
108
86
  # @return [Integer] Hash code
109
87
  def hash
110
- [branch, query, filters, order].hash
88
+ [branch, q].hash
111
89
  end
112
90
 
113
91
  # Builds the object from hash
@@ -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.
@@ -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).<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>.
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.
@@ -18,6 +18,10 @@ module Phrase
18
18
 
19
19
  attr_accessor :translation_keys_ignored
20
20
 
21
+ attr_accessor :processed_translations
22
+
23
+ attr_accessor :upload_total_translations
24
+
21
25
  # Attribute mapping from ruby-style variable name to JSON key.
22
26
  def self.attribute_map
23
27
  {
@@ -28,7 +32,9 @@ module Phrase
28
32
  :'translations_created' => :'translations_created',
29
33
  :'translations_updated' => :'translations_updated',
30
34
  :'tags_created' => :'tags_created',
31
- :'translation_keys_ignored' => :'translation_keys_ignored'
35
+ :'translation_keys_ignored' => :'translation_keys_ignored',
36
+ :'processed_translations' => :'processed_translations',
37
+ :'upload_total_translations' => :'upload_total_translations'
32
38
  }
33
39
  end
34
40
 
@@ -42,7 +48,9 @@ module Phrase
42
48
  :'translations_created' => :'Integer',
43
49
  :'translations_updated' => :'Integer',
44
50
  :'tags_created' => :'Integer',
45
- :'translation_keys_ignored' => :'Integer'
51
+ :'translation_keys_ignored' => :'Integer',
52
+ :'processed_translations' => :'Integer',
53
+ :'upload_total_translations' => :'Integer'
46
54
  }
47
55
  end
48
56
 
@@ -98,6 +106,14 @@ module Phrase
98
106
  if attributes.key?(:'translation_keys_ignored')
99
107
  self.translation_keys_ignored = attributes[:'translation_keys_ignored']
100
108
  end
109
+
110
+ if attributes.key?(:'processed_translations')
111
+ self.processed_translations = attributes[:'processed_translations']
112
+ end
113
+
114
+ if attributes.key?(:'upload_total_translations')
115
+ self.upload_total_translations = attributes[:'upload_total_translations']
116
+ end
101
117
  end
102
118
 
103
119
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -125,7 +141,9 @@ module Phrase
125
141
  translations_created == o.translations_created &&
126
142
  translations_updated == o.translations_updated &&
127
143
  tags_created == o.tags_created &&
128
- translation_keys_ignored == o.translation_keys_ignored
144
+ translation_keys_ignored == o.translation_keys_ignored &&
145
+ processed_translations == o.processed_translations &&
146
+ upload_total_translations == o.upload_total_translations
129
147
  end
130
148
 
131
149
  # @see the `==` method
@@ -137,7 +155,7 @@ module Phrase
137
155
  # Calculates hash code according to all attributes.
138
156
  # @return [Integer] Hash code
139
157
  def hash
140
- [locales_created, translation_keys_created, translation_keys_updated, translation_keys_unmentioned, translations_created, translations_updated, tags_created, translation_keys_ignored].hash
158
+ [locales_created, translation_keys_created, translation_keys_updated, translation_keys_unmentioned, translations_created, translations_updated, tags_created, translation_keys_ignored, processed_translations, upload_total_translations].hash
141
159
  end
142
160
 
143
161
  # Builds the object from hash
@@ -1,3 +1,3 @@
1
1
  module Phrase
2
- VERSION = '4.4.0'
2
+ VERSION = '4.7.0'
3
3
  end
data/lib/phrase.rb CHANGED
@@ -31,7 +31,6 @@ require 'phrase/models/comment_create_parameters1'
31
31
  require 'phrase/models/comment_mark_read_parameters'
32
32
  require 'phrase/models/comment_reaction'
33
33
  require 'phrase/models/comment_update_parameters'
34
- require 'phrase/models/comments_list_parameters'
35
34
  require 'phrase/models/current_user'
36
35
  require 'phrase/models/custom_metadata_data_type'
37
36
  require 'phrase/models/custom_metadata_properties_create_parameters'
@@ -155,7 +154,6 @@ require 'phrase/models/release_preview'
155
154
  require 'phrase/models/release_trigger'
156
155
  require 'phrase/models/release_update_parameters'
157
156
  require 'phrase/models/release_update_parameters1'
158
- require 'phrase/models/replies_list_parameters'
159
157
  require 'phrase/models/repo_sync'
160
158
  require 'phrase/models/repo_sync_event'
161
159
  require 'phrase/models/screenshot'
@@ -198,6 +196,7 @@ require 'phrase/models/translation_key_details'
198
196
  require 'phrase/models/translation_order'
199
197
  require 'phrase/models/translation_parent'
200
198
  require 'phrase/models/translation_review_parameters'
199
+ require 'phrase/models/translation_unreview_parameters'
201
200
  require 'phrase/models/translation_unverify_parameters'
202
201
  require 'phrase/models/translation_update_parameters'
203
202
  require 'phrase/models/translation_verify_parameters'
@@ -207,6 +206,7 @@ require 'phrase/models/translations_exclude_parameters'
207
206
  require 'phrase/models/translations_include_parameters'
208
207
  require 'phrase/models/translations_review_parameters'
209
208
  require 'phrase/models/translations_search_parameters'
209
+ require 'phrase/models/translations_unreview_parameters'
210
210
  require 'phrase/models/translations_unverify_parameters'
211
211
  require 'phrase/models/translations_verify_parameters'
212
212
  require 'phrase/models/upload'
@@ -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. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Comparing a branch may take several minutes depending on the project size.&lt;/i&gt;
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. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Creating a new branch may take several minutes depending on the project size.&lt;/i&gt;
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. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Merging a branch may take several minutes depending on diff size.&lt;/i&gt;
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
@@ -26,7 +26,6 @@ describe 'CommentRepliesApi' do
26
26
  # @param project_id Project ID
27
27
  # @param key_id Translation Key ID
28
28
  # @param comment_id Comment ID
29
- # @param replies_list_parameters
30
29
  # @param [Hash] opts the optional parameters
31
30
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
32
31
  # @option opts [Integer] :page Page number
@@ -136,7 +136,6 @@ describe 'CommentsApi' do
136
136
  # List all comments for a key.
137
137
  # @param project_id Project ID
138
138
  # @param key_id Translation Key ID
139
- # @param comments_list_parameters
140
139
  # @param [Hash] opts the optional parameters
141
140
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
142
141
  # @option opts [Integer] :page Page number
@@ -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 &lt;code&gt;project_ids&lt;/code&gt; and &lt;code&gt;locale_ids&lt;/code&gt; assigned to access them. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
25
+ # Invite a person to an account. Developers and translators need &#x60;project_ids&#x60; and &#x60;locale_ids&#x60; assigned to access them. Access token scope must include &#x60;team.manage&#x60;.
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 &lt;code&gt;team.manage&lt;/code&gt;.
39
+ # Delete an existing invitation (must not be accepted yet). Access token scope must include &#x60;team.manage&#x60;.
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 &lt;code&gt;team.manage&lt;/code&gt;.
53
+ # Resend the invitation email (must not be accepted yet). Access token scope must include &#x60;team.manage&#x60;.
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 &lt;code&gt;team.manage&lt;/code&gt;.
67
+ # Get details on a single invitation. Access token scope must include &#x60;team.manage&#x60;.
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 &lt;code&gt;email&lt;/code&gt; cannot be updated. Developers and translators need &lt;code&gt;project_ids&lt;/code&gt; and &lt;code&gt;locale_ids&lt;/code&gt; assigned to access them. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
81
+ # Update an existing invitation (must not be accepted yet). The &#x60;email&#x60; cannot be updated. Developers and translators need &#x60;project_ids&#x60; and &#x60;locale_ids&#x60; assigned to access them. Access token scope must include &#x60;team.manage&#x60;.
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&#39;s invitation access
96
- # Update member&#39;s settings in the invitations. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
96
+ # Update member&#39;s settings in the invitations. Access token scope must include &#x60;team.manage&#x60;.
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 &lt;code&gt;team.manage&lt;/code&gt;.
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 &#x60;team.manage&#x60;.
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)
@@ -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: &lt;code&gt;draft&lt;/code&gt;, &lt;code&gt;in_progress&lt;/code&gt;, &lt;code&gt;completed&lt;/code&gt;
197
+ # @option opts [String] :state filter by state of job; valid states are: &#x60;draft&#x60;, &#x60;in_progress&#x60;, &#x60;completed&#x60;
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: &lt;code&gt;draft&lt;/code&gt;, &lt;code&gt;in_progress&lt;/code&gt;, &lt;code&gt;completed&lt;/code&gt;
217
+ # @option opts [String] :state filter by state of job; valid states are: &#x60;draft&#x60;, &#x60;in_progress&#x60;, &#x60;completed&#x60;
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
@@ -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).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; &lt;br/&gt; &lt;p&gt;&lt;strong&gt;Caution:&lt;/strong&gt; Query parameters with empty values will be treated as though they are not included in the request and will be ignored.&lt;/p&gt; &lt;br/&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.
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: - &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids - &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes - &#x60;tags:tag_name&#x60; to filter for keys with certain tags - &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) - &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries - &#x60;unmentioned_in_upload:upload_id,...&#x60; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples).
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).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; &lt;br/&gt; &lt;p&gt;&lt;strong&gt;Caution:&lt;/strong&gt; Query parameters with empty values will be treated as though they are not included in the request and will be ignored.&lt;/p&gt; &lt;br/&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.
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: - &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids - &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes - &#x60;tags:tag_name&#x60; to filter for keys with certain tags - &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) - &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries - &#x60;unmentioned_in_upload:upload_id,...&#x60; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored. Find more examples [here](/en/api/strings/usage-examples).
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 &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)
32
- # @option opts [String] :if_none_match ETag condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)
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 &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)
49
- # @option opts [String] :if_none_match ETag condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)
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 &lt;code&gt;team.manage&lt;/code&gt;.
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 &#x60;team.manage&#x60;.
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 &lt;code&gt;team.manage&lt;/code&gt;.
39
+ # Get details on a single user in the account. Access token scope must include &#x60;team.manage&#x60;.
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 &lt;code&gt;project_ids&lt;/code&gt; and &lt;code&gt;locale_ids&lt;/code&gt; assigned to access them. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
53
+ # Update user permissions in the account. Developers and translators need &#x60;project_ids&#x60; and &#x60;locale_ids&#x60; assigned to access them. Access token scope must include &#x60;team.manage&#x60;.
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&#39;s project settings
68
- # Update user settings in the project. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
68
+ # Update user settings in the project. Access token scope must include &#x60;team.manage&#x60;.
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 &lt;code&gt;team.manage&lt;/code&gt;.
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 &#x60;team.manage&#x60;.
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)
@@ -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 &lt;code&gt;orders.create&lt;/code&gt;.
40
+ # Create a new order. Access token scope must include &#x60;orders.create&#x60;.
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.&lt;br&gt; Note: Currently only one release trigger can exist per 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
@@ -22,7 +22,7 @@ describe 'SearchApi' do
22
22
 
23
23
  # unit tests for search_in_account
24
24
  # Search across projects
25
- # Search for keys and translations in all account projects &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.&lt;/i&gt;
25
+ # Search for keys and translations in all account projects *Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.*
26
26
  # @param account_id Account ID
27
27
  # @param search_in_account_parameters
28
28
  # @param [Hash] opts the optional parameters
@@ -56,6 +56,7 @@ describe 'TagsApi' do
56
56
  # @param name name
57
57
  # @param [Hash] opts the optional parameters
58
58
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
59
+ # @option opts [Boolean] :omit_statistics omit statistics in the response
59
60
  # @option opts [String] :branch specify the branch to use
60
61
  # @return [TagWithStats]
61
62
  describe 'tag_show test' do
@@ -94,6 +94,21 @@ describe 'TranslationsApi' do
94
94
  end
95
95
  end
96
96
 
97
+ # unit tests for translation_unreview
98
+ # Unreview a translation
99
+ # Mark a reviewed translation as translated.
100
+ # @param project_id Project ID
101
+ # @param id ID
102
+ # @param translation_unreview_parameters
103
+ # @param [Hash] opts the optional parameters
104
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
105
+ # @return [TranslationDetails]
106
+ describe 'translation_unreview test' do
107
+ it 'should work' do
108
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
109
+ end
110
+ end
111
+
97
112
  # unit tests for translation_unverify
98
113
  # Mark a translation as unverified
99
114
  # Mark an existing translation as unverified.
@@ -151,7 +166,7 @@ describe 'TranslationsApi' do
151
166
  # @option opts [String] :branch specify the branch to use
152
167
  # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
153
168
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
154
- # @option opts [String] :q Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.
169
+ # @option opts [String] :q Specify a query to find translations by content (including wildcards). The following qualifiers are supported in the query: * &#x60;id:translation_id,...&#x60; for queries on a comma-separated list of ids * &#x60;unverified:{true|false}&#x60; for verification status * &#x60;tags:XYZ&#x60; for tags on the translation * &#x60;excluded:{true|false}&#x60; for exclusion status * &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries Find more examples [here](/en/api/strings/usage-examples).
155
170
  # @return [Array<Translation>]
156
171
  describe 'translations_by_key test' do
157
172
  it 'should work' do
@@ -161,7 +176,7 @@ describe 'TranslationsApi' do
161
176
 
162
177
  # unit tests for translations_by_locale
163
178
  # List translations by locale
164
- # List translations for a specific locale. If you want to download all translations for one locale we recommend to use the &lt;code&gt;locales#download&lt;/code&gt; endpoint.
179
+ # List translations for a specific locale. If you want to download all translations for one locale we recommend to use the &#x60;locales#download&#x60; endpoint.
165
180
  # @param project_id Project ID
166
181
  # @param locale_id Locale ID
167
182
  # @param [Hash] opts the optional parameters
@@ -171,7 +186,7 @@ describe 'TranslationsApi' do
171
186
  # @option opts [String] :branch specify the branch to use
172
187
  # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
173
188
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
174
- # @option opts [String] :q Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.
189
+ # @option opts [String] :q Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: - &#x60;id:translation_id,...&#x60; for queries on a comma-separated list of ids - &#x60;unverified:{true|false}&#x60; for verification status - &#x60;tags:XYZ&#x60; for tags on the translation - &#x60;excluded:{true|false}&#x60; for exclusion status - &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries Find more examples [here](/en/api/strings/usage-examples).
175
190
  # @return [Array<Translation>]
176
191
  describe 'translations_by_locale test' do
177
192
  it 'should work' do
@@ -209,18 +224,18 @@ describe 'TranslationsApi' do
209
224
 
210
225
  # unit tests for translations_list
211
226
  # List all translations
212
- # List translations for the given project. If you want to download all translations for one locale we recommend to use the &lt;code&gt;locales#download&lt;/code&gt; endpoint.
227
+ # List translations for the given project. If you want to download all translations for one locale we recommend to use the &#x60;locales#download&#x60; endpoint.
213
228
  # @param project_id Project ID
214
229
  # @param [Hash] opts the optional parameters
215
230
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
216
- # @option opts [String] :if_modified_since Last modified condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)
217
- # @option opts [String] :if_none_match ETag condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional)
231
+ # @option opts [String] :if_modified_since Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
232
+ # @option opts [String] :if_none_match ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
218
233
  # @option opts [Integer] :page Page number
219
234
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
220
235
  # @option opts [String] :branch specify the branch to use
221
236
  # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
222
237
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
223
- # @option opts [String] :q Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;reviewed_after:2013-02-21T00:00:00Z&lt;/code&gt; for fetching translations that were reviewed after the given timestamp&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.
238
+ # @option opts [String] :q Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * &#x60;id:translation_id,...&#x60; for queries on a comma-separated list of ids * &#x60;tags:XYZ&#x60; for tags on the translation * &#x60;unverified:{true|false}&#x60; for verification status * &#x60;excluded:{true|false}&#x60; for exclusion status * &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries * &#x60;reviewed_after:2013-02-21T00:00:00Z&#x60; for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples).
224
239
  # @return [Array<Translation>]
225
240
  describe 'translations_list test' do
226
241
  it 'should work' do
@@ -244,7 +259,7 @@ describe 'TranslationsApi' do
244
259
 
245
260
  # unit tests for translations_search
246
261
  # Search translations
247
- # Search translations for the given project. Provides the same search interface as &lt;code&gt;translations#index&lt;/code&gt; but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the &lt;code&gt;locales#download&lt;/code&gt; endpoint.
262
+ # Search translations for the given project. Provides the same search interface as &#x60;translations#index&#x60; but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the &#x60;locales#download&#x60; endpoint.
248
263
  # @param project_id Project ID
249
264
  # @param translations_search_parameters
250
265
  # @param [Hash] opts the optional parameters
@@ -258,6 +273,20 @@ describe 'TranslationsApi' do
258
273
  end
259
274
  end
260
275
 
276
+ # unit tests for translations_unreview_collection
277
+ # Unreview translations selected by query
278
+ # Unreview translations matching query.
279
+ # @param project_id Project ID
280
+ # @param translations_unreview_parameters
281
+ # @param [Hash] opts the optional parameters
282
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
283
+ # @return [AffectedCount]
284
+ describe 'translations_unreview_collection test' do
285
+ it 'should work' do
286
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
287
+ end
288
+ end
289
+
261
290
  # unit tests for translations_unverify_collection
262
291
  # Unverify translations by query
263
292
  # Mark translations matching query as unverified.