phrase 2.8.3 → 2.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +31 -12
- data/docs/BitbucketSyncApi.md +2 -2
- data/docs/BranchesApi.md +3 -3
- data/docs/GitHubSyncApi.md +2 -2
- data/docs/GitLabSyncApi.md +2 -2
- data/docs/JobCommentsApi.md +6 -6
- data/docs/JobLocale.md +3 -1
- data/docs/JobLocaleUpdateParameters.md +5 -1
- data/docs/JobLocalesCreateParameters.md +6 -2
- data/docs/JobTemplateDetails.md +35 -0
- data/docs/JobTemplateDetails1.md +21 -0
- data/docs/JobTemplateLocaleUpdateParameters.md +6 -2
- data/docs/{JobTemplateLocale.md → JobTemplateLocales.md} +6 -4
- data/docs/JobTemplateLocalesApi.md +8 -8
- data/docs/JobTemplateLocalesCreateParameters.md +5 -1
- data/docs/JobTemplatesApi.md +41 -41
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/LocaleTeamPreview.md +21 -0
- data/docs/{JobTemplateUserPreview.md → LocaleUserPreview.md} +2 -2
- data/docs/LocalesApi.md +8 -4
- data/docs/NotificationGroupDetail.md +1 -1
- data/docs/NotificationGroupsApi.md +4 -4
- data/docs/NotificationsApi.md +4 -4
- data/docs/OrganizationJobTemplate.md +25 -0
- data/docs/OrganizationJobTemplateCreateParameters.md +19 -0
- data/docs/OrganizationJobTemplateDetails.md +31 -0
- data/docs/OrganizationJobTemplateLocaleUpdateParameters.md +27 -0
- data/docs/OrganizationJobTemplateLocalesApi.md +341 -0
- data/docs/OrganizationJobTemplateLocalesCreateParameters.md +27 -0
- data/docs/OrganizationJobTemplateUpdateParameters.md +19 -0
- data/docs/OrganizationJobTemplatesApi.md +331 -0
- data/docs/Project.md +2 -0
- data/docs/ProjectCreateParameters.md +5 -1
- data/docs/ProjectDetails.md +2 -0
- data/docs/ProjectUpdateParameters.md +5 -1
- data/docs/SearchApi.md +1 -1
- data/docs/TranslationsApi.md +23 -19
- data/docs/TranslationsExcludeParameters.md +1 -1
- data/docs/TranslationsIncludeParameters.md +1 -1
- data/docs/TranslationsReviewParameters.md +1 -1
- data/docs/TranslationsSearchParameters.md +1 -1
- data/docs/TranslationsUnverifyParameters.md +1 -1
- data/docs/TranslationsVerifyParameters.md +1 -1
- data/docs/UploadsApi.md +3 -3
- data/lib/phrase/api/bitbucket_sync_api.rb +4 -4
- data/lib/phrase/api/branches_api.rb +6 -6
- data/lib/phrase/api/git_hub_sync_api.rb +4 -4
- data/lib/phrase/api/git_lab_sync_api.rb +4 -4
- data/lib/phrase/api/job_comments_api.rb +9 -9
- data/lib/phrase/api/job_template_locales_api.rb +12 -12
- data/lib/phrase/api/job_templates_api.rb +72 -72
- data/lib/phrase/api/locales_api.rb +10 -4
- data/lib/phrase/api/notification_groups_api.rb +6 -6
- data/lib/phrase/api/notifications_api.rb +6 -6
- data/lib/phrase/api/organization_job_template_locales_api.rb +408 -0
- data/lib/phrase/api/organization_job_templates_api.rb +378 -0
- data/lib/phrase/api/search_api.rb +2 -2
- data/lib/phrase/api/translations_api.rb +20 -14
- data/lib/phrase/api/uploads_api.rb +2 -2
- data/lib/phrase/models/job_locale.rb +13 -2
- data/lib/phrase/models/job_locale_update_parameters.rb +28 -4
- data/lib/phrase/models/job_locales_create_parameters.rb +33 -4
- data/lib/phrase/models/job_template_details.rb +285 -0
- data/lib/phrase/models/job_template_details1.rb +214 -0
- data/lib/phrase/models/job_template_locale_update_parameters.rb +28 -9
- data/lib/phrase/models/{job_template_locale.rb → job_template_locales.rb} +18 -7
- data/lib/phrase/models/job_template_locales_create_parameters.rb +28 -4
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/locale_team_preview.rb +212 -0
- data/lib/phrase/models/{job_template_user_preview.rb → locale_user_preview.rb} +3 -3
- data/lib/phrase/models/notification_group_detail.rb +1 -1
- data/lib/phrase/models/organization_job_template.rb +230 -0
- data/lib/phrase/models/organization_job_template_create_parameters.rb +210 -0
- data/lib/phrase/models/organization_job_template_details.rb +267 -0
- data/lib/phrase/models/organization_job_template_locale_update_parameters.rb +253 -0
- data/lib/phrase/models/organization_job_template_locales_create_parameters.rb +263 -0
- data/lib/phrase/models/organization_job_template_update_parameters.rb +210 -0
- data/lib/phrase/models/project.rb +10 -1
- data/lib/phrase/models/project_create_parameters.rb +22 -2
- data/lib/phrase/models/project_details.rb +10 -1
- data/lib/phrase/models/project_update_parameters.rb +22 -2
- data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
- data/lib/phrase/models/translations_include_parameters.rb +1 -1
- data/lib/phrase/models/translations_review_parameters.rb +1 -1
- data/lib/phrase/models/translations_search_parameters.rb +1 -1
- data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
- data/lib/phrase/models/translations_verify_parameters.rb +1 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +13 -2
- data/spec/api/bitbucket_sync_api_spec.rb +2 -2
- data/spec/api/branches_api_spec.rb +3 -3
- data/spec/api/git_hub_sync_api_spec.rb +2 -2
- data/spec/api/git_lab_sync_api_spec.rb +2 -2
- data/spec/api/job_comments_api_spec.rb +3 -3
- data/spec/api/job_template_locales_api_spec.rb +4 -4
- data/spec/api/job_templates_api_spec.rb +17 -17
- data/spec/api/locales_api_spec.rb +4 -2
- data/spec/api/notification_groups_api_spec.rb +2 -2
- data/spec/api/notifications_api_spec.rb +2 -2
- data/spec/api/organization_job_template_locales_api_spec.rb +100 -0
- data/spec/api/organization_job_templates_api_spec.rb +95 -0
- data/spec/api/search_api_spec.rb +1 -1
- data/spec/api/translations_api_spec.rb +9 -7
- data/spec/api/uploads_api_spec.rb +1 -1
- data/spec/models/job_locale_spec.rb +6 -0
- data/spec/models/job_locale_update_parameters_spec.rb +12 -0
- data/spec/models/job_locales_create_parameters_spec.rb +12 -0
- data/spec/models/job_template_details1_spec.rb +41 -0
- data/spec/models/job_template_details_spec.rb +83 -0
- data/spec/models/job_template_locale_update_parameters_spec.rb +12 -0
- data/spec/models/job_template_locales_create_parameters_spec.rb +12 -0
- data/spec/models/{job_template_locale_spec.rb → job_template_locales_spec.rb} +12 -6
- data/spec/models/locale_team_preview_spec.rb +41 -0
- data/spec/models/{job_template_user_preview_spec.rb → locale_user_preview_spec.rb} +6 -6
- data/spec/models/organization_job_template_create_parameters_spec.rb +35 -0
- data/spec/models/organization_job_template_details_spec.rb +71 -0
- data/spec/models/organization_job_template_locale_update_parameters_spec.rb +59 -0
- data/spec/models/organization_job_template_locales_create_parameters_spec.rb +59 -0
- data/spec/models/organization_job_template_spec.rb +53 -0
- data/spec/models/organization_job_template_update_parameters_spec.rb +35 -0
- data/spec/models/project_create_parameters_spec.rb +12 -0
- data/spec/models/project_details_spec.rb +6 -0
- data/spec/models/project_spec.rb +6 -0
- data/spec/models/project_update_parameters_spec.rb +12 -0
- metadata +269 -225
|
@@ -0,0 +1,331 @@
|
|
|
1
|
+
# Phrase::OrganizationJobTemplatesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**organization_job_template_create**](OrganizationJobTemplatesApi.md#organization_job_template_create) | **POST** /accounts/{account_id}/job_templates | Create an organization job template
|
|
8
|
+
[**organization_job_template_delete**](OrganizationJobTemplatesApi.md#organization_job_template_delete) | **DELETE** /accounts/{account_id}/job_templates/{id} | Delete an organization job template
|
|
9
|
+
[**organization_job_template_update**](OrganizationJobTemplatesApi.md#organization_job_template_update) | **PATCH** /accounts/{account_id}/job_templates/{id} | Update an organization job template
|
|
10
|
+
[**organization_job_templates_list**](OrganizationJobTemplatesApi.md#organization_job_templates_list) | **GET** /accounts/{account_id}/job_templates | List organization job templates
|
|
11
|
+
[**organization_job_templates_show**](OrganizationJobTemplatesApi.md#organization_job_templates_show) | **GET** /accounts/{account_id}/job_templates/{id} | Get a single organization job template
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## organization_job_template_create
|
|
16
|
+
|
|
17
|
+
> OrganizationJobTemplateDetails organization_job_template_create(account_id, organization_job_template_create_parameters, opts)
|
|
18
|
+
|
|
19
|
+
Create an organization job template
|
|
20
|
+
|
|
21
|
+
Create a new organization job template.
|
|
22
|
+
|
|
23
|
+
### Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
# load the gem
|
|
27
|
+
require 'phrase'
|
|
28
|
+
# setup authorization
|
|
29
|
+
Phrase.configure do |config|
|
|
30
|
+
# Configure HTTP basic authorization: Basic
|
|
31
|
+
config.username = 'YOUR USERNAME'
|
|
32
|
+
config.password = 'YOUR PASSWORD'
|
|
33
|
+
|
|
34
|
+
# Configure API key authorization: Token
|
|
35
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
36
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
api_instance = Phrase::OrganizationJobTemplatesApi.new
|
|
40
|
+
account_id = 'account_id_example' # String | Account ID
|
|
41
|
+
organization_job_template_create_parameters = Phrase::OrganizationJobTemplateCreateParameters.new # OrganizationJobTemplateCreateParameters |
|
|
42
|
+
opts = {
|
|
43
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
#Create an organization job template
|
|
48
|
+
result = api_instance.organization_job_template_create(account_id, organization_job_template_create_parameters, opts)
|
|
49
|
+
pp result
|
|
50
|
+
rescue Phrase::ApiError => e
|
|
51
|
+
puts "Exception when calling OrganizationJobTemplatesApi->organization_job_template_create: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
Name | Type | Description | Notes
|
|
59
|
+
------------- | ------------- | ------------- | -------------
|
|
60
|
+
**account_id** | **String**| Account ID |
|
|
61
|
+
**organization_job_template_create_parameters** | [**OrganizationJobTemplateCreateParameters**](OrganizationJobTemplateCreateParameters.md)| |
|
|
62
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
63
|
+
|
|
64
|
+
### Return type
|
|
65
|
+
|
|
66
|
+
Response<([**OrganizationJobTemplateDetails**](OrganizationJobTemplateDetails.md))>
|
|
67
|
+
|
|
68
|
+
### Authorization
|
|
69
|
+
|
|
70
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
71
|
+
|
|
72
|
+
### HTTP request headers
|
|
73
|
+
|
|
74
|
+
- **Content-Type**: application/json
|
|
75
|
+
- **Accept**: application/json
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
## organization_job_template_delete
|
|
79
|
+
|
|
80
|
+
> organization_job_template_delete(account_id, id, opts)
|
|
81
|
+
|
|
82
|
+
Delete an organization job template
|
|
83
|
+
|
|
84
|
+
Delete an existing organization job template.
|
|
85
|
+
|
|
86
|
+
### Example
|
|
87
|
+
|
|
88
|
+
```ruby
|
|
89
|
+
# load the gem
|
|
90
|
+
require 'phrase'
|
|
91
|
+
# setup authorization
|
|
92
|
+
Phrase.configure do |config|
|
|
93
|
+
# Configure HTTP basic authorization: Basic
|
|
94
|
+
config.username = 'YOUR USERNAME'
|
|
95
|
+
config.password = 'YOUR PASSWORD'
|
|
96
|
+
|
|
97
|
+
# Configure API key authorization: Token
|
|
98
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
99
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
api_instance = Phrase::OrganizationJobTemplatesApi.new
|
|
103
|
+
account_id = 'account_id_example' # String | Account ID
|
|
104
|
+
id = 'id_example' # String | ID
|
|
105
|
+
opts = {
|
|
106
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
begin
|
|
110
|
+
#Delete an organization job template
|
|
111
|
+
api_instance.organization_job_template_delete(account_id, id, opts)
|
|
112
|
+
rescue Phrase::ApiError => e
|
|
113
|
+
puts "Exception when calling OrganizationJobTemplatesApi->organization_job_template_delete: #{e}"
|
|
114
|
+
end
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Parameters
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
Name | Type | Description | Notes
|
|
121
|
+
------------- | ------------- | ------------- | -------------
|
|
122
|
+
**account_id** | **String**| Account ID |
|
|
123
|
+
**id** | **String**| ID |
|
|
124
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
125
|
+
|
|
126
|
+
### Return type
|
|
127
|
+
|
|
128
|
+
Response<(nil (empty response body))>
|
|
129
|
+
|
|
130
|
+
### Authorization
|
|
131
|
+
|
|
132
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
133
|
+
|
|
134
|
+
### HTTP request headers
|
|
135
|
+
|
|
136
|
+
- **Content-Type**: Not defined
|
|
137
|
+
- **Accept**: Not defined
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
## organization_job_template_update
|
|
141
|
+
|
|
142
|
+
> OrganizationJobTemplateDetails organization_job_template_update(account_id, id, organization_job_template_update_parameters, opts)
|
|
143
|
+
|
|
144
|
+
Update an organization job template
|
|
145
|
+
|
|
146
|
+
Update an existing organization job template.
|
|
147
|
+
|
|
148
|
+
### Example
|
|
149
|
+
|
|
150
|
+
```ruby
|
|
151
|
+
# load the gem
|
|
152
|
+
require 'phrase'
|
|
153
|
+
# setup authorization
|
|
154
|
+
Phrase.configure do |config|
|
|
155
|
+
# Configure HTTP basic authorization: Basic
|
|
156
|
+
config.username = 'YOUR USERNAME'
|
|
157
|
+
config.password = 'YOUR PASSWORD'
|
|
158
|
+
|
|
159
|
+
# Configure API key authorization: Token
|
|
160
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
161
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
api_instance = Phrase::OrganizationJobTemplatesApi.new
|
|
165
|
+
account_id = 'account_id_example' # String | Account ID
|
|
166
|
+
id = 'id_example' # String | ID
|
|
167
|
+
organization_job_template_update_parameters = Phrase::OrganizationJobTemplateUpdateParameters.new # OrganizationJobTemplateUpdateParameters |
|
|
168
|
+
opts = {
|
|
169
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
begin
|
|
173
|
+
#Update an organization job template
|
|
174
|
+
result = api_instance.organization_job_template_update(account_id, id, organization_job_template_update_parameters, opts)
|
|
175
|
+
pp result
|
|
176
|
+
rescue Phrase::ApiError => e
|
|
177
|
+
puts "Exception when calling OrganizationJobTemplatesApi->organization_job_template_update: #{e}"
|
|
178
|
+
end
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Parameters
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
Name | Type | Description | Notes
|
|
185
|
+
------------- | ------------- | ------------- | -------------
|
|
186
|
+
**account_id** | **String**| Account ID |
|
|
187
|
+
**id** | **String**| ID |
|
|
188
|
+
**organization_job_template_update_parameters** | [**OrganizationJobTemplateUpdateParameters**](OrganizationJobTemplateUpdateParameters.md)| |
|
|
189
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
190
|
+
|
|
191
|
+
### Return type
|
|
192
|
+
|
|
193
|
+
Response<([**OrganizationJobTemplateDetails**](OrganizationJobTemplateDetails.md))>
|
|
194
|
+
|
|
195
|
+
### Authorization
|
|
196
|
+
|
|
197
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
198
|
+
|
|
199
|
+
### HTTP request headers
|
|
200
|
+
|
|
201
|
+
- **Content-Type**: application/json
|
|
202
|
+
- **Accept**: application/json
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
## organization_job_templates_list
|
|
206
|
+
|
|
207
|
+
> Array<OrganizationJobTemplate> organization_job_templates_list(account_id, opts)
|
|
208
|
+
|
|
209
|
+
List organization job templates
|
|
210
|
+
|
|
211
|
+
List all job templates for the given account.
|
|
212
|
+
|
|
213
|
+
### Example
|
|
214
|
+
|
|
215
|
+
```ruby
|
|
216
|
+
# load the gem
|
|
217
|
+
require 'phrase'
|
|
218
|
+
# setup authorization
|
|
219
|
+
Phrase.configure do |config|
|
|
220
|
+
# Configure HTTP basic authorization: Basic
|
|
221
|
+
config.username = 'YOUR USERNAME'
|
|
222
|
+
config.password = 'YOUR PASSWORD'
|
|
223
|
+
|
|
224
|
+
# Configure API key authorization: Token
|
|
225
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
226
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
api_instance = Phrase::OrganizationJobTemplatesApi.new
|
|
230
|
+
account_id = 'account_id_example' # String | Account ID
|
|
231
|
+
opts = {
|
|
232
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
233
|
+
page: 1, # Integer | Page number
|
|
234
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
begin
|
|
238
|
+
#List organization job templates
|
|
239
|
+
result = api_instance.organization_job_templates_list(account_id, opts)
|
|
240
|
+
pp result
|
|
241
|
+
rescue Phrase::ApiError => e
|
|
242
|
+
puts "Exception when calling OrganizationJobTemplatesApi->organization_job_templates_list: #{e}"
|
|
243
|
+
end
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### Parameters
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
Name | Type | Description | Notes
|
|
250
|
+
------------- | ------------- | ------------- | -------------
|
|
251
|
+
**account_id** | **String**| Account ID |
|
|
252
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
253
|
+
**page** | **Integer**| Page number | [optional]
|
|
254
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
255
|
+
|
|
256
|
+
### Return type
|
|
257
|
+
|
|
258
|
+
Response<([**Array<OrganizationJobTemplate>**](OrganizationJobTemplate.md))>
|
|
259
|
+
|
|
260
|
+
### Authorization
|
|
261
|
+
|
|
262
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
263
|
+
|
|
264
|
+
### HTTP request headers
|
|
265
|
+
|
|
266
|
+
- **Content-Type**: Not defined
|
|
267
|
+
- **Accept**: application/json
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
## organization_job_templates_show
|
|
271
|
+
|
|
272
|
+
> OrganizationJobTemplateDetails organization_job_templates_show(account_id, id, opts)
|
|
273
|
+
|
|
274
|
+
Get a single organization job template
|
|
275
|
+
|
|
276
|
+
Get details on a single organization job template for a given account.
|
|
277
|
+
|
|
278
|
+
### Example
|
|
279
|
+
|
|
280
|
+
```ruby
|
|
281
|
+
# load the gem
|
|
282
|
+
require 'phrase'
|
|
283
|
+
# setup authorization
|
|
284
|
+
Phrase.configure do |config|
|
|
285
|
+
# Configure HTTP basic authorization: Basic
|
|
286
|
+
config.username = 'YOUR USERNAME'
|
|
287
|
+
config.password = 'YOUR PASSWORD'
|
|
288
|
+
|
|
289
|
+
# Configure API key authorization: Token
|
|
290
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
291
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
api_instance = Phrase::OrganizationJobTemplatesApi.new
|
|
295
|
+
account_id = 'account_id_example' # String | Account ID
|
|
296
|
+
id = 'id_example' # String | ID
|
|
297
|
+
opts = {
|
|
298
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
begin
|
|
302
|
+
#Get a single organization job template
|
|
303
|
+
result = api_instance.organization_job_templates_show(account_id, id, opts)
|
|
304
|
+
pp result
|
|
305
|
+
rescue Phrase::ApiError => e
|
|
306
|
+
puts "Exception when calling OrganizationJobTemplatesApi->organization_job_templates_show: #{e}"
|
|
307
|
+
end
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
### Parameters
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
Name | Type | Description | Notes
|
|
314
|
+
------------- | ------------- | ------------- | -------------
|
|
315
|
+
**account_id** | **String**| Account ID |
|
|
316
|
+
**id** | **String**| ID |
|
|
317
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
318
|
+
|
|
319
|
+
### Return type
|
|
320
|
+
|
|
321
|
+
Response<([**OrganizationJobTemplateDetails**](OrganizationJobTemplateDetails.md))>
|
|
322
|
+
|
|
323
|
+
### Authorization
|
|
324
|
+
|
|
325
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
326
|
+
|
|
327
|
+
### HTTP request headers
|
|
328
|
+
|
|
329
|
+
- **Content-Type**: Not defined
|
|
330
|
+
- **Accept**: application/json
|
|
331
|
+
|
data/docs/Project.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**slug** | **String** | | [optional]
|
|
10
10
|
**main_format** | **String** | | [optional]
|
|
11
11
|
**project_image_url** | **String** | | [optional]
|
|
12
|
+
**media** | **String** | | [optional]
|
|
12
13
|
**account** | [**Account**](Account.md) | | [optional]
|
|
13
14
|
**space** | [**Space1**](Space1.md) | | [optional]
|
|
14
15
|
**point_of_contact** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
@@ -25,6 +26,7 @@ instance = Phrase::Project.new(id: null,
|
|
|
25
26
|
slug: null,
|
|
26
27
|
main_format: null,
|
|
27
28
|
project_image_url: null,
|
|
29
|
+
media: null,
|
|
28
30
|
account: null,
|
|
29
31
|
space: null,
|
|
30
32
|
point_of_contact: null,
|
|
@@ -5,11 +5,13 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Name of the project | [optional]
|
|
8
|
-
**main_format** | **String** | 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/
|
|
8
|
+
**main_format** | **String** | 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>. | [optional]
|
|
9
|
+
**media** | **String** | (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. | [optional]
|
|
9
10
|
**shares_translation_memory** | **Boolean** | Indicates whether the project should share the account's translation memory | [optional]
|
|
10
11
|
**project_image** | **File** | Image to identify the project | [optional]
|
|
11
12
|
**remove_project_image** | **Boolean** | Indicates whether the project image should be deleted. | [optional]
|
|
12
13
|
**account_id** | **String** | Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
14
|
+
**point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. | [optional]
|
|
13
15
|
**source_project_id** | **String** | 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. | [optional]
|
|
14
16
|
**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\". <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\">Read more</a> | [optional]
|
|
15
17
|
**machine_translation_enabled** | **Boolean** | (Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest | [optional]
|
|
@@ -36,10 +38,12 @@ require 'Phrase'
|
|
|
36
38
|
|
|
37
39
|
instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
|
|
38
40
|
main_format: yml,
|
|
41
|
+
media: Python,
|
|
39
42
|
shares_translation_memory: true,
|
|
40
43
|
project_image: null,
|
|
41
44
|
remove_project_image: null,
|
|
42
45
|
account_id: abcd1234,
|
|
46
|
+
point_of_contact: abcd1234,
|
|
43
47
|
source_project_id: abcd1234,
|
|
44
48
|
workflow: review,
|
|
45
49
|
machine_translation_enabled: true,
|
data/docs/ProjectDetails.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**slug** | **String** | | [optional]
|
|
10
10
|
**main_format** | **String** | | [optional]
|
|
11
11
|
**project_image_url** | **String** | | [optional]
|
|
12
|
+
**media** | **String** | | [optional]
|
|
12
13
|
**account** | [**Account**](Account.md) | | [optional]
|
|
13
14
|
**space** | [**Space1**](Space1.md) | | [optional]
|
|
14
15
|
**point_of_contact** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
@@ -26,6 +27,7 @@ instance = Phrase::ProjectDetails.new(id: null,
|
|
|
26
27
|
slug: null,
|
|
27
28
|
main_format: null,
|
|
28
29
|
project_image_url: null,
|
|
30
|
+
media: null,
|
|
29
31
|
account: null,
|
|
30
32
|
space: null,
|
|
31
33
|
point_of_contact: null,
|
|
@@ -6,7 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**account_id** | **String** | Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in. | [optional]
|
|
8
8
|
**name** | **String** | (Optional) Name of the project | [optional]
|
|
9
|
-
**
|
|
9
|
+
**point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. Pass `null` to unset. | [optional]
|
|
10
|
+
**main_format** | **String** | (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>. | [optional]
|
|
11
|
+
**media** | **String** | (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. | [optional]
|
|
10
12
|
**shares_translation_memory** | **Boolean** | (Optional) Indicates whether the project should share the account's translation memory | [optional]
|
|
11
13
|
**project_image** | **File** | (Optional) Image to identify the project | [optional]
|
|
12
14
|
**remove_project_image** | **Boolean** | (Optional) Indicates whether the project image should be deleted. | [optional]
|
|
@@ -35,7 +37,9 @@ require 'Phrase'
|
|
|
35
37
|
|
|
36
38
|
instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
|
|
37
39
|
name: My Android Project,
|
|
40
|
+
point_of_contact: abcd1234,
|
|
38
41
|
main_format: yml,
|
|
42
|
+
media: Python,
|
|
39
43
|
shares_translation_memory: true,
|
|
40
44
|
project_image: null,
|
|
41
45
|
remove_project_image: false,
|
data/docs/SearchApi.md
CHANGED
|
@@ -14,7 +14,7 @@ Method | HTTP request | Description
|
|
|
14
14
|
|
|
15
15
|
Search across projects
|
|
16
16
|
|
|
17
|
-
Search for keys and translations in all account projects
|
|
17
|
+
Search for keys and translations in all account projects <br><br><i>Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.</i>
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
data/docs/TranslationsApi.md
CHANGED
|
@@ -6,7 +6,7 @@ Method | HTTP request | Description
|
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**translation_create**](TranslationsApi.md#translation_create) | **POST** /projects/{project_id}/translations | Create a translation
|
|
8
8
|
[**translation_exclude**](TranslationsApi.md#translation_exclude) | **PATCH** /projects/{project_id}/translations/{id}/exclude | Exclude a translation from export
|
|
9
|
-
[**translation_include**](TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include |
|
|
9
|
+
[**translation_include**](TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
|
|
10
10
|
[**translation_review**](TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
|
|
11
11
|
[**translation_show**](TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
|
|
12
12
|
[**translation_unverify**](TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
|
|
@@ -14,13 +14,13 @@ Method | HTTP request | Description
|
|
|
14
14
|
[**translation_verify**](TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
|
|
15
15
|
[**translations_by_key**](TranslationsApi.md#translations_by_key) | **GET** /projects/{project_id}/keys/{key_id}/translations | List translations by key
|
|
16
16
|
[**translations_by_locale**](TranslationsApi.md#translations_by_locale) | **GET** /projects/{project_id}/locales/{locale_id}/translations | List translations by locale
|
|
17
|
-
[**translations_exclude_collection**](TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude |
|
|
18
|
-
[**translations_include_collection**](TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include |
|
|
17
|
+
[**translations_exclude_collection**](TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude | Exclude translations by query
|
|
18
|
+
[**translations_include_collection**](TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include | Include translations by query
|
|
19
19
|
[**translations_list**](TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
|
|
20
20
|
[**translations_review_collection**](TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
|
|
21
21
|
[**translations_search**](TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
|
|
22
|
-
[**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify |
|
|
23
|
-
[**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations
|
|
22
|
+
[**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
|
|
23
|
+
[**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -156,7 +156,7 @@ Response<([**TranslationDetails**](TranslationDetails.md))>
|
|
|
156
156
|
|
|
157
157
|
> TranslationDetails translation_include(project_id, id, translation_include_parameters, opts)
|
|
158
158
|
|
|
159
|
-
|
|
159
|
+
Include a translation
|
|
160
160
|
|
|
161
161
|
Remove exclude from export flag from an existing translation.
|
|
162
162
|
|
|
@@ -185,7 +185,7 @@ opts = {
|
|
|
185
185
|
}
|
|
186
186
|
|
|
187
187
|
begin
|
|
188
|
-
#
|
|
188
|
+
#Include a translation
|
|
189
189
|
result = api_instance.translation_include(project_id, id, translation_include_parameters, opts)
|
|
190
190
|
pp result
|
|
191
191
|
rescue Phrase::ApiError => e
|
|
@@ -651,7 +651,7 @@ opts = {
|
|
|
651
651
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
652
652
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
653
653
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
654
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><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>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</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>.
|
|
654
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | 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>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</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>.
|
|
655
655
|
}
|
|
656
656
|
|
|
657
657
|
begin
|
|
@@ -676,7 +676,7 @@ Name | Type | Description | Notes
|
|
|
676
676
|
**branch** | **String**| specify the branch to use | [optional]
|
|
677
677
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
678
678
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
679
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards).<br><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>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</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>. | [optional]
|
|
679
|
+
**q** | **String**| 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>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</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>. | [optional]
|
|
680
680
|
|
|
681
681
|
### Return type
|
|
682
682
|
|
|
@@ -696,7 +696,7 @@ Response<([**Array<Translation>**](Translation.md))>
|
|
|
696
696
|
|
|
697
697
|
> AffectedCount translations_exclude_collection(project_id, translations_exclude_parameters, opts)
|
|
698
698
|
|
|
699
|
-
|
|
699
|
+
Exclude translations by query
|
|
700
700
|
|
|
701
701
|
Exclude translations matching query from locale export.
|
|
702
702
|
|
|
@@ -724,7 +724,7 @@ opts = {
|
|
|
724
724
|
}
|
|
725
725
|
|
|
726
726
|
begin
|
|
727
|
-
#
|
|
727
|
+
#Exclude translations by query
|
|
728
728
|
result = api_instance.translations_exclude_collection(project_id, translations_exclude_parameters, opts)
|
|
729
729
|
pp result
|
|
730
730
|
rescue Phrase::ApiError => e
|
|
@@ -759,7 +759,7 @@ Response<([**AffectedCount**](AffectedCount.md))>
|
|
|
759
759
|
|
|
760
760
|
> AffectedCount translations_include_collection(project_id, translations_include_parameters, opts)
|
|
761
761
|
|
|
762
|
-
|
|
762
|
+
Include translations by query
|
|
763
763
|
|
|
764
764
|
Include translations matching query in locale export.
|
|
765
765
|
|
|
@@ -787,7 +787,7 @@ opts = {
|
|
|
787
787
|
}
|
|
788
788
|
|
|
789
789
|
begin
|
|
790
|
-
#
|
|
790
|
+
#Include translations by query
|
|
791
791
|
result = api_instance.translations_include_collection(project_id, translations_include_parameters, opts)
|
|
792
792
|
pp result
|
|
793
793
|
rescue Phrase::ApiError => e
|
|
@@ -846,12 +846,14 @@ api_instance = Phrase::TranslationsApi.new
|
|
|
846
846
|
project_id = 'project_id_example' # String | Project ID
|
|
847
847
|
opts = {
|
|
848
848
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
849
|
+
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
|
850
|
+
if_none_match: 'if_none_match_example', # String | ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
|
849
851
|
page: 1, # Integer | Page number
|
|
850
852
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
851
853
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
852
854
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
853
855
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
854
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><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>.
|
|
856
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | 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>.
|
|
855
857
|
}
|
|
856
858
|
|
|
857
859
|
begin
|
|
@@ -870,12 +872,14 @@ Name | Type | Description | Notes
|
|
|
870
872
|
------------- | ------------- | ------------- | -------------
|
|
871
873
|
**project_id** | **String**| Project ID |
|
|
872
874
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
875
|
+
**if_modified_since** | **String**| Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
|
876
|
+
**if_none_match** | **String**| ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
|
873
877
|
**page** | **Integer**| Page number | [optional]
|
|
874
878
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
875
879
|
**branch** | **String**| specify the branch to use | [optional]
|
|
876
880
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
877
881
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
878
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards).<br><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>. | [optional]
|
|
882
|
+
**q** | **String**| 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>. | [optional]
|
|
879
883
|
|
|
880
884
|
### Return type
|
|
881
885
|
|
|
@@ -1025,7 +1029,7 @@ Response<([**Array<Translation>**](Translation.md))>
|
|
|
1025
1029
|
|
|
1026
1030
|
> AffectedCount translations_unverify_collection(project_id, translations_unverify_parameters, opts)
|
|
1027
1031
|
|
|
1028
|
-
|
|
1032
|
+
Unverify translations by query
|
|
1029
1033
|
|
|
1030
1034
|
Mark translations matching query as unverified.
|
|
1031
1035
|
|
|
@@ -1053,7 +1057,7 @@ opts = {
|
|
|
1053
1057
|
}
|
|
1054
1058
|
|
|
1055
1059
|
begin
|
|
1056
|
-
#
|
|
1060
|
+
#Unverify translations by query
|
|
1057
1061
|
result = api_instance.translations_unverify_collection(project_id, translations_unverify_parameters, opts)
|
|
1058
1062
|
pp result
|
|
1059
1063
|
rescue Phrase::ApiError => e
|
|
@@ -1088,7 +1092,7 @@ Response<([**AffectedCount**](AffectedCount.md))>
|
|
|
1088
1092
|
|
|
1089
1093
|
> AffectedCount translations_verify_collection(project_id, translations_verify_parameters, opts)
|
|
1090
1094
|
|
|
1091
|
-
Verify translations
|
|
1095
|
+
Verify translations by query
|
|
1092
1096
|
|
|
1093
1097
|
Verify translations matching query.
|
|
1094
1098
|
|
|
@@ -1116,7 +1120,7 @@ opts = {
|
|
|
1116
1120
|
}
|
|
1117
1121
|
|
|
1118
1122
|
begin
|
|
1119
|
-
#Verify translations
|
|
1123
|
+
#Verify translations by query
|
|
1120
1124
|
result = api_instance.translations_verify_collection(project_id, translations_verify_parameters, opts)
|
|
1121
1125
|
pp result
|
|
1122
1126
|
rescue Phrase::ApiError => e
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><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>. | [optional]
|
|
8
|
+
**q** | **String** | 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>. | [optional]
|
|
9
9
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
10
10
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><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>. | [optional]
|
|
8
|
+
**q** | **String** | 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>. | [optional]
|
|
9
9
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
10
10
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><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>. | [optional]
|
|
8
|
+
**q** | **String** | 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>. | [optional]
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|