phrase 1.0.12 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +56 -9
- data/docs/Account.md +3 -1
- data/docs/AccountDetails.md +5 -1
- data/docs/AccountDetails1.md +3 -1
- data/docs/AccountSearchResult.md +29 -0
- data/docs/Branch.md +5 -1
- data/docs/Comment.md +3 -1
- data/docs/CurrentUser.md +31 -0
- data/docs/JobLocale.md +5 -1
- data/docs/JobTemplate.md +29 -0
- data/docs/JobTemplateCreateParameters.md +21 -0
- data/docs/JobTemplateLocale.md +23 -0
- data/docs/JobTemplateLocaleUpdateParameters.md +23 -0
- data/docs/JobTemplateLocalesApi.md +347 -0
- data/docs/JobTemplateLocalesCreateParameters.md +23 -0
- data/docs/JobTemplatePreview.md +19 -0
- data/docs/JobTemplateUpdateParameters.md +21 -0
- data/docs/JobTemplateUserPreview.md +23 -0
- data/docs/JobTemplatesApi.md +337 -0
- data/docs/KeysApi.md +137 -9
- data/docs/KeysExcludeParameters.md +23 -0
- data/docs/KeysIncludeParameters.md +23 -0
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/KeysTagParameters.md +1 -1
- data/docs/KeysUntagParameters.md +1 -1
- data/docs/LocalePreview1.md +23 -0
- data/docs/LocalesApi.md +73 -6
- data/docs/MemberSpaces.md +2 -2
- data/docs/MemberUpdateParameters.md +4 -2
- data/docs/Notification.md +41 -0
- data/docs/NotificationGroup.md +23 -0
- data/docs/NotificationGroupDetail.md +27 -0
- data/docs/NotificationGroupsApi.md +194 -0
- data/docs/NotificationsApi.md +194 -0
- data/docs/OrderCreateParameters.md +2 -0
- data/docs/Project.md +2 -0
- data/docs/ProjectCreateParameters.md +35 -1
- data/docs/ProjectDetails.md +2 -0
- data/docs/ProjectUpdateParameters.md +43 -9
- data/docs/ProjectsApi.md +7 -1
- data/docs/ScreenshotCreateParameters.md +3 -1
- data/docs/ScreenshotMarkerCreateParameters.md +3 -1
- data/docs/ScreenshotMarkerUpdateParameters.md +3 -1
- data/docs/ScreenshotMarkersApi.md +9 -3
- data/docs/ScreenshotUpdateParameters.md +3 -1
- data/docs/ScreenshotsApi.md +8 -2
- data/docs/SearchApi.md +72 -0
- data/docs/SearchInAccountParameters.md +23 -0
- data/docs/Space1.md +25 -0
- data/docs/Subscription.md +19 -0
- data/docs/TranslationOrder.md +2 -0
- data/docs/TranslationsApi.md +25 -25
- data/docs/User.md +0 -2
- data/docs/UsersApi.md +2 -2
- data/docs/Variable.md +23 -0
- data/docs/VariableCreateParameters.md +19 -0
- data/docs/VariableUpdateParameters.md +19 -0
- data/docs/VariablesApi.md +331 -0
- data/lib/phrase.rb +28 -0
- data/lib/phrase/api/job_template_locales_api.rb +417 -0
- data/lib/phrase/api/job_templates_api.rb +387 -0
- data/lib/phrase/api/keys_api.rb +158 -10
- data/lib/phrase/api/locales_api.rb +76 -5
- data/lib/phrase/api/notification_groups_api.rb +202 -0
- data/lib/phrase/api/notifications_api.rb +202 -0
- data/lib/phrase/api/projects_api.rb +9 -0
- data/lib/phrase/api/screenshot_markers_api.rb +9 -0
- data/lib/phrase/api/screenshots_api.rb +9 -0
- data/lib/phrase/api/search_api.rb +84 -0
- data/lib/phrase/api/translations_api.rb +35 -35
- data/lib/phrase/api/users_api.rb +3 -3
- data/lib/phrase/api/variables_api.rb +378 -0
- data/lib/phrase/models/account.rb +13 -4
- data/lib/phrase/models/account_details.rb +22 -4
- data/lib/phrase/models/account_details1.rb +10 -1
- data/lib/phrase/models/account_search_result.rb +250 -0
- data/lib/phrase/models/branch.rb +19 -1
- data/lib/phrase/models/comment.rb +15 -4
- data/lib/phrase/models/current_user.rb +257 -0
- data/lib/phrase/models/job_locale.rb +22 -4
- data/lib/phrase/models/job_template.rb +248 -0
- data/lib/phrase/models/job_template_create_parameters.rb +220 -0
- data/lib/phrase/models/job_template_locale.rb +223 -0
- data/lib/phrase/models/job_template_locale_update_parameters.rb +234 -0
- data/lib/phrase/models/job_template_locales_create_parameters.rb +234 -0
- data/lib/phrase/models/job_template_preview.rb +203 -0
- data/lib/phrase/models/job_template_update_parameters.rb +220 -0
- data/lib/phrase/models/job_template_user_preview.rb +221 -0
- data/lib/phrase/models/keys_exclude_parameters.rb +225 -0
- data/lib/phrase/models/keys_include_parameters.rb +225 -0
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/keys_tag_parameters.rb +1 -1
- data/lib/phrase/models/keys_untag_parameters.rb +1 -1
- data/lib/phrase/models/locale_preview1.rb +221 -0
- data/lib/phrase/models/member_spaces.rb +2 -2
- data/lib/phrase/models/member_update_parameters.rb +12 -2
- data/lib/phrase/models/notification.rb +302 -0
- data/lib/phrase/models/notification_group.rb +221 -0
- data/lib/phrase/models/notification_group_detail.rb +239 -0
- data/lib/phrase/models/order_create_parameters.rb +11 -1
- data/lib/phrase/models/project.rb +10 -1
- data/lib/phrase/models/project_create_parameters.rb +174 -4
- data/lib/phrase/models/project_details.rb +10 -1
- data/lib/phrase/models/project_update_parameters.rb +183 -13
- data/lib/phrase/models/screenshot_create_parameters.rb +11 -1
- data/lib/phrase/models/screenshot_marker_create_parameters.rb +11 -1
- data/lib/phrase/models/screenshot_marker_update_parameters.rb +11 -1
- data/lib/phrase/models/screenshot_update_parameters.rb +11 -1
- data/lib/phrase/models/search_in_account_parameters.rb +225 -0
- data/lib/phrase/models/space1.rb +230 -0
- data/lib/phrase/models/subscription.rb +203 -0
- data/lib/phrase/models/translation_order.rb +10 -1
- data/lib/phrase/models/user.rb +1 -10
- data/lib/phrase/models/variable.rb +221 -0
- data/lib/phrase/models/variable_create_parameters.rb +205 -0
- data/lib/phrase/models/variable_update_parameters.rb +205 -0
- data/lib/phrase/version.rb +1 -1
- data/spec/api/job_template_locales_api_spec.rb +103 -0
- data/spec/api/job_templates_api_spec.rb +98 -0
- data/spec/api/keys_api_spec.rb +32 -4
- data/spec/api/locales_api_spec.rb +17 -2
- data/spec/api/notification_groups_api_spec.rb +62 -0
- data/spec/api/notifications_api_spec.rb +62 -0
- data/spec/api/projects_api_spec.rb +3 -0
- data/spec/api/screenshot_markers_api_spec.rb +3 -0
- data/spec/api/screenshots_api_spec.rb +3 -0
- data/spec/api/search_api_spec.rb +37 -0
- data/spec/api/translations_api_spec.rb +10 -10
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/variables_api_spec.rb +95 -0
- data/spec/models/account_details1_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +12 -0
- data/spec/models/account_search_result_spec.rb +65 -0
- data/spec/models/account_spec.rb +6 -0
- data/spec/models/branch_spec.rb +12 -0
- data/spec/models/comment_spec.rb +6 -0
- data/spec/models/current_user_spec.rb +71 -0
- data/spec/models/job_locale_spec.rb +12 -0
- data/spec/models/job_template_create_parameters_spec.rb +41 -0
- data/spec/models/job_template_locale_spec.rb +47 -0
- data/spec/models/job_template_locale_update_parameters_spec.rb +47 -0
- data/spec/models/job_template_locales_create_parameters_spec.rb +47 -0
- data/spec/models/job_template_preview_spec.rb +35 -0
- data/spec/models/job_template_spec.rb +65 -0
- data/spec/models/job_template_update_parameters_spec.rb +41 -0
- data/spec/models/job_template_user_preview_spec.rb +47 -0
- data/spec/models/keys_exclude_parameters_spec.rb +47 -0
- data/spec/models/keys_include_parameters_spec.rb +47 -0
- data/spec/models/locale_preview1_spec.rb +47 -0
- data/spec/models/member_update_parameters_spec.rb +6 -0
- data/spec/models/notification_group_detail_spec.rb +59 -0
- data/spec/models/notification_group_spec.rb +47 -0
- data/spec/models/notification_spec.rb +101 -0
- data/spec/models/order_create_parameters_spec.rb +6 -0
- data/spec/models/project_create_parameters_spec.rb +102 -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 +103 -1
- data/spec/models/screenshot_create_parameters_spec.rb +6 -0
- data/spec/models/screenshot_marker_create_parameters_spec.rb +6 -0
- data/spec/models/screenshot_marker_update_parameters_spec.rb +6 -0
- data/spec/models/screenshot_update_parameters_spec.rb +6 -0
- data/spec/models/search_in_account_parameters_spec.rb +47 -0
- data/spec/models/space1_spec.rb +53 -0
- data/spec/models/subscription_spec.rb +35 -0
- data/spec/models/translation_order_spec.rb +6 -0
- data/spec/models/user_spec.rb +0 -6
- data/spec/models/variable_create_parameters_spec.rb +35 -0
- data/spec/models/variable_spec.rb +47 -0
- data/spec/models/variable_update_parameters_spec.rb +35 -0
- metadata +281 -169
@@ -0,0 +1,337 @@
|
|
1
|
+
# Phrase::JobTemplatesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**job_template_create**](JobTemplatesApi.md#job_template_create) | **POST** /projects/{project_id}/job_templates | Create a job template
|
8
|
+
[**job_template_delete**](JobTemplatesApi.md#job_template_delete) | **DELETE** /projects/{project_id}/job_templates/{id} | Delete a job template
|
9
|
+
[**job_template_show**](JobTemplatesApi.md#job_template_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
|
10
|
+
[**job_template_update**](JobTemplatesApi.md#job_template_update) | **PATCH** /projects/{project_id}/job_templates/{id} | Update a job template
|
11
|
+
[**job_templates_list**](JobTemplatesApi.md#job_templates_list) | **GET** /projects/{project_id}/job_templates | List job templates
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
## job_template_create
|
16
|
+
|
17
|
+
> Object job_template_create(project_id, job_template_create_parameters, opts)
|
18
|
+
|
19
|
+
Create a job template
|
20
|
+
|
21
|
+
Create a new 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::JobTemplatesApi.new
|
40
|
+
project_id = 'project_id_example' # String | Project ID
|
41
|
+
job_template_create_parameters = Phrase::JobTemplateCreateParameters.new # JobTemplateCreateParameters |
|
42
|
+
opts = {
|
43
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
44
|
+
}
|
45
|
+
|
46
|
+
begin
|
47
|
+
#Create a job template
|
48
|
+
result = api_instance.job_template_create(project_id, job_template_create_parameters, opts)
|
49
|
+
pp result
|
50
|
+
rescue Phrase::ApiError => e
|
51
|
+
puts "Exception when calling JobTemplatesApi->job_template_create: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**project_id** | **String**| Project ID |
|
61
|
+
**job_template_create_parameters** | [**JobTemplateCreateParameters**](JobTemplateCreateParameters.md)| |
|
62
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
63
|
+
|
64
|
+
### Return type
|
65
|
+
|
66
|
+
Response<(**Object**)>
|
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
|
+
## job_template_delete
|
79
|
+
|
80
|
+
> job_template_delete(project_id, id, opts)
|
81
|
+
|
82
|
+
Delete a job template
|
83
|
+
|
84
|
+
Delete an existing 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::JobTemplatesApi.new
|
103
|
+
project_id = 'project_id_example' # String | Project 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
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
108
|
+
}
|
109
|
+
|
110
|
+
begin
|
111
|
+
#Delete a job template
|
112
|
+
api_instance.job_template_delete(project_id, id, opts)
|
113
|
+
rescue Phrase::ApiError => e
|
114
|
+
puts "Exception when calling JobTemplatesApi->job_template_delete: #{e}"
|
115
|
+
end
|
116
|
+
```
|
117
|
+
|
118
|
+
### Parameters
|
119
|
+
|
120
|
+
|
121
|
+
Name | Type | Description | Notes
|
122
|
+
------------- | ------------- | ------------- | -------------
|
123
|
+
**project_id** | **String**| Project ID |
|
124
|
+
**id** | **String**| ID |
|
125
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
126
|
+
**branch** | **String**| specify the branch to use | [optional]
|
127
|
+
|
128
|
+
### Return type
|
129
|
+
|
130
|
+
Response<(nil (empty response body))>
|
131
|
+
|
132
|
+
### Authorization
|
133
|
+
|
134
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
135
|
+
|
136
|
+
### HTTP request headers
|
137
|
+
|
138
|
+
- **Content-Type**: Not defined
|
139
|
+
- **Accept**: Not defined
|
140
|
+
|
141
|
+
|
142
|
+
## job_template_show
|
143
|
+
|
144
|
+
> Object job_template_show(project_id, id, opts)
|
145
|
+
|
146
|
+
Get a single job template
|
147
|
+
|
148
|
+
Get details on a single job template for a given project.
|
149
|
+
|
150
|
+
### Example
|
151
|
+
|
152
|
+
```ruby
|
153
|
+
# load the gem
|
154
|
+
require 'phrase'
|
155
|
+
# setup authorization
|
156
|
+
Phrase.configure do |config|
|
157
|
+
# Configure HTTP basic authorization: Basic
|
158
|
+
config.username = 'YOUR USERNAME'
|
159
|
+
config.password = 'YOUR PASSWORD'
|
160
|
+
|
161
|
+
# Configure API key authorization: Token
|
162
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
163
|
+
config.api_key_prefix['Authorization'] = 'token'
|
164
|
+
end
|
165
|
+
|
166
|
+
api_instance = Phrase::JobTemplatesApi.new
|
167
|
+
project_id = 'project_id_example' # String | Project ID
|
168
|
+
id = 'id_example' # String | ID
|
169
|
+
opts = {
|
170
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
171
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
172
|
+
}
|
173
|
+
|
174
|
+
begin
|
175
|
+
#Get a single job template
|
176
|
+
result = api_instance.job_template_show(project_id, id, opts)
|
177
|
+
pp result
|
178
|
+
rescue Phrase::ApiError => e
|
179
|
+
puts "Exception when calling JobTemplatesApi->job_template_show: #{e}"
|
180
|
+
end
|
181
|
+
```
|
182
|
+
|
183
|
+
### Parameters
|
184
|
+
|
185
|
+
|
186
|
+
Name | Type | Description | Notes
|
187
|
+
------------- | ------------- | ------------- | -------------
|
188
|
+
**project_id** | **String**| Project ID |
|
189
|
+
**id** | **String**| ID |
|
190
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
191
|
+
**branch** | **String**| specify the branch to use | [optional]
|
192
|
+
|
193
|
+
### Return type
|
194
|
+
|
195
|
+
Response<(**Object**)>
|
196
|
+
|
197
|
+
### Authorization
|
198
|
+
|
199
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
200
|
+
|
201
|
+
### HTTP request headers
|
202
|
+
|
203
|
+
- **Content-Type**: Not defined
|
204
|
+
- **Accept**: application/json
|
205
|
+
|
206
|
+
|
207
|
+
## job_template_update
|
208
|
+
|
209
|
+
> Object job_template_update(project_id, id, job_template_update_parameters, opts)
|
210
|
+
|
211
|
+
Update a job template
|
212
|
+
|
213
|
+
Update an existing job template.
|
214
|
+
|
215
|
+
### Example
|
216
|
+
|
217
|
+
```ruby
|
218
|
+
# load the gem
|
219
|
+
require 'phrase'
|
220
|
+
# setup authorization
|
221
|
+
Phrase.configure do |config|
|
222
|
+
# Configure HTTP basic authorization: Basic
|
223
|
+
config.username = 'YOUR USERNAME'
|
224
|
+
config.password = 'YOUR PASSWORD'
|
225
|
+
|
226
|
+
# Configure API key authorization: Token
|
227
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
228
|
+
config.api_key_prefix['Authorization'] = 'token'
|
229
|
+
end
|
230
|
+
|
231
|
+
api_instance = Phrase::JobTemplatesApi.new
|
232
|
+
project_id = 'project_id_example' # String | Project ID
|
233
|
+
id = 'id_example' # String | ID
|
234
|
+
job_template_update_parameters = Phrase::JobTemplateUpdateParameters.new # JobTemplateUpdateParameters |
|
235
|
+
opts = {
|
236
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
237
|
+
}
|
238
|
+
|
239
|
+
begin
|
240
|
+
#Update a job template
|
241
|
+
result = api_instance.job_template_update(project_id, id, job_template_update_parameters, opts)
|
242
|
+
pp result
|
243
|
+
rescue Phrase::ApiError => e
|
244
|
+
puts "Exception when calling JobTemplatesApi->job_template_update: #{e}"
|
245
|
+
end
|
246
|
+
```
|
247
|
+
|
248
|
+
### Parameters
|
249
|
+
|
250
|
+
|
251
|
+
Name | Type | Description | Notes
|
252
|
+
------------- | ------------- | ------------- | -------------
|
253
|
+
**project_id** | **String**| Project ID |
|
254
|
+
**id** | **String**| ID |
|
255
|
+
**job_template_update_parameters** | [**JobTemplateUpdateParameters**](JobTemplateUpdateParameters.md)| |
|
256
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
257
|
+
|
258
|
+
### Return type
|
259
|
+
|
260
|
+
Response<(**Object**)>
|
261
|
+
|
262
|
+
### Authorization
|
263
|
+
|
264
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
265
|
+
|
266
|
+
### HTTP request headers
|
267
|
+
|
268
|
+
- **Content-Type**: application/json
|
269
|
+
- **Accept**: application/json
|
270
|
+
|
271
|
+
|
272
|
+
## job_templates_list
|
273
|
+
|
274
|
+
> Array<JobTemplate> job_templates_list(project_id, opts)
|
275
|
+
|
276
|
+
List job templates
|
277
|
+
|
278
|
+
List all job templates for the given project.
|
279
|
+
|
280
|
+
### Example
|
281
|
+
|
282
|
+
```ruby
|
283
|
+
# load the gem
|
284
|
+
require 'phrase'
|
285
|
+
# setup authorization
|
286
|
+
Phrase.configure do |config|
|
287
|
+
# Configure HTTP basic authorization: Basic
|
288
|
+
config.username = 'YOUR USERNAME'
|
289
|
+
config.password = 'YOUR PASSWORD'
|
290
|
+
|
291
|
+
# Configure API key authorization: Token
|
292
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
293
|
+
config.api_key_prefix['Authorization'] = 'token'
|
294
|
+
end
|
295
|
+
|
296
|
+
api_instance = Phrase::JobTemplatesApi.new
|
297
|
+
project_id = 'project_id_example' # String | Project ID
|
298
|
+
opts = {
|
299
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
300
|
+
page: 1, # Integer | Page number
|
301
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
302
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
303
|
+
}
|
304
|
+
|
305
|
+
begin
|
306
|
+
#List job templates
|
307
|
+
result = api_instance.job_templates_list(project_id, opts)
|
308
|
+
pp result
|
309
|
+
rescue Phrase::ApiError => e
|
310
|
+
puts "Exception when calling JobTemplatesApi->job_templates_list: #{e}"
|
311
|
+
end
|
312
|
+
```
|
313
|
+
|
314
|
+
### Parameters
|
315
|
+
|
316
|
+
|
317
|
+
Name | Type | Description | Notes
|
318
|
+
------------- | ------------- | ------------- | -------------
|
319
|
+
**project_id** | **String**| Project ID |
|
320
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
321
|
+
**page** | **Integer**| Page number | [optional]
|
322
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
323
|
+
**branch** | **String**| specify the branch to use | [optional]
|
324
|
+
|
325
|
+
### Return type
|
326
|
+
|
327
|
+
Response<([**Array<JobTemplate>**](JobTemplate.md))>
|
328
|
+
|
329
|
+
### Authorization
|
330
|
+
|
331
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
332
|
+
|
333
|
+
### HTTP request headers
|
334
|
+
|
335
|
+
- **Content-Type**: Not defined
|
336
|
+
- **Accept**: application/json
|
337
|
+
|
data/docs/KeysApi.md
CHANGED
@@ -8,7 +8,9 @@ Method | HTTP request | Description
|
|
8
8
|
[**key_delete**](KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
|
9
9
|
[**key_show**](KeysApi.md#key_show) | **GET** /projects/{project_id}/keys/{id} | Get a single key
|
10
10
|
[**key_update**](KeysApi.md#key_update) | **PATCH** /projects/{project_id}/keys/{id} | Update a key
|
11
|
-
[**
|
11
|
+
[**keys_delete_collection**](KeysApi.md#keys_delete_collection) | **DELETE** /projects/{project_id}/keys | Delete collection of keys
|
12
|
+
[**keys_exclude**](KeysApi.md#keys_exclude) | **PATCH** /projects/{project_id}/keys/exclude | Exclude a locale on a collection of keys
|
13
|
+
[**keys_include**](KeysApi.md#keys_include) | **PATCH** /projects/{project_id}/keys/include | Include a locale on a collection of keys
|
12
14
|
[**keys_list**](KeysApi.md#keys_list) | **GET** /projects/{project_id}/keys | List keys
|
13
15
|
[**keys_search**](KeysApi.md#keys_search) | **POST** /projects/{project_id}/keys/search | Search keys
|
14
16
|
[**keys_tag**](KeysApi.md#keys_tag) | **PATCH** /projects/{project_id}/keys/tag | Add tags to collection of keys
|
@@ -273,9 +275,9 @@ Response<([**TranslationKeyDetails**](TranslationKeyDetails.md))>
|
|
273
275
|
- **Accept**: application/json
|
274
276
|
|
275
277
|
|
276
|
-
##
|
278
|
+
## keys_delete_collection
|
277
279
|
|
278
|
-
> AffectedResources
|
280
|
+
> AffectedResources keys_delete_collection(project_id, opts)
|
279
281
|
|
280
282
|
Delete collection of keys
|
281
283
|
|
@@ -302,16 +304,16 @@ project_id = 'project_id_example' # String | Project ID
|
|
302
304
|
opts = {
|
303
305
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
304
306
|
branch: 'my-feature-branch', # String | specify the branch to use
|
305
|
-
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names -
|
307
|
+
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
306
308
|
locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
307
309
|
}
|
308
310
|
|
309
311
|
begin
|
310
312
|
#Delete collection of keys
|
311
|
-
result = api_instance.
|
313
|
+
result = api_instance.keys_delete_collection(project_id, opts)
|
312
314
|
pp result
|
313
315
|
rescue Phrase::ApiError => e
|
314
|
-
puts "Exception when calling KeysApi->
|
316
|
+
puts "Exception when calling KeysApi->keys_delete_collection: #{e}"
|
315
317
|
end
|
316
318
|
```
|
317
319
|
|
@@ -323,7 +325,7 @@ Name | Type | Description | Notes
|
|
323
325
|
**project_id** | **String**| Project ID |
|
324
326
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
325
327
|
**branch** | **String**| specify the branch to use | [optional]
|
326
|
-
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names -
|
328
|
+
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
327
329
|
**locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
328
330
|
|
329
331
|
### Return type
|
@@ -340,6 +342,132 @@ Response<([**AffectedResources**](AffectedResources.md))>
|
|
340
342
|
- **Accept**: application/json
|
341
343
|
|
342
344
|
|
345
|
+
## keys_exclude
|
346
|
+
|
347
|
+
> AffectedResources keys_exclude(project_id, keys_exclude_parameters, opts)
|
348
|
+
|
349
|
+
Exclude a locale on a collection of keys
|
350
|
+
|
351
|
+
Exclude a locale on keys matching query. Same constraints as list.
|
352
|
+
|
353
|
+
### Example
|
354
|
+
|
355
|
+
```ruby
|
356
|
+
# load the gem
|
357
|
+
require 'phrase'
|
358
|
+
# setup authorization
|
359
|
+
Phrase.configure do |config|
|
360
|
+
# Configure HTTP basic authorization: Basic
|
361
|
+
config.username = 'YOUR USERNAME'
|
362
|
+
config.password = 'YOUR PASSWORD'
|
363
|
+
|
364
|
+
# Configure API key authorization: Token
|
365
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
366
|
+
config.api_key_prefix['Authorization'] = 'token'
|
367
|
+
end
|
368
|
+
|
369
|
+
api_instance = Phrase::KeysApi.new
|
370
|
+
project_id = 'project_id_example' # String | Project ID
|
371
|
+
keys_exclude_parameters = Phrase::KeysExcludeParameters.new # KeysExcludeParameters |
|
372
|
+
opts = {
|
373
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
374
|
+
}
|
375
|
+
|
376
|
+
begin
|
377
|
+
#Exclude a locale on a collection of keys
|
378
|
+
result = api_instance.keys_exclude(project_id, keys_exclude_parameters, opts)
|
379
|
+
pp result
|
380
|
+
rescue Phrase::ApiError => e
|
381
|
+
puts "Exception when calling KeysApi->keys_exclude: #{e}"
|
382
|
+
end
|
383
|
+
```
|
384
|
+
|
385
|
+
### Parameters
|
386
|
+
|
387
|
+
|
388
|
+
Name | Type | Description | Notes
|
389
|
+
------------- | ------------- | ------------- | -------------
|
390
|
+
**project_id** | **String**| Project ID |
|
391
|
+
**keys_exclude_parameters** | [**KeysExcludeParameters**](KeysExcludeParameters.md)| |
|
392
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
393
|
+
|
394
|
+
### Return type
|
395
|
+
|
396
|
+
Response<([**AffectedResources**](AffectedResources.md))>
|
397
|
+
|
398
|
+
### Authorization
|
399
|
+
|
400
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
401
|
+
|
402
|
+
### HTTP request headers
|
403
|
+
|
404
|
+
- **Content-Type**: application/json
|
405
|
+
- **Accept**: application/json
|
406
|
+
|
407
|
+
|
408
|
+
## keys_include
|
409
|
+
|
410
|
+
> AffectedResources keys_include(project_id, keys_include_parameters, opts)
|
411
|
+
|
412
|
+
Include a locale on a collection of keys
|
413
|
+
|
414
|
+
Include a locale on keys matching query. Same constraints as list.
|
415
|
+
|
416
|
+
### Example
|
417
|
+
|
418
|
+
```ruby
|
419
|
+
# load the gem
|
420
|
+
require 'phrase'
|
421
|
+
# setup authorization
|
422
|
+
Phrase.configure do |config|
|
423
|
+
# Configure HTTP basic authorization: Basic
|
424
|
+
config.username = 'YOUR USERNAME'
|
425
|
+
config.password = 'YOUR PASSWORD'
|
426
|
+
|
427
|
+
# Configure API key authorization: Token
|
428
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
429
|
+
config.api_key_prefix['Authorization'] = 'token'
|
430
|
+
end
|
431
|
+
|
432
|
+
api_instance = Phrase::KeysApi.new
|
433
|
+
project_id = 'project_id_example' # String | Project ID
|
434
|
+
keys_include_parameters = Phrase::KeysIncludeParameters.new # KeysIncludeParameters |
|
435
|
+
opts = {
|
436
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
437
|
+
}
|
438
|
+
|
439
|
+
begin
|
440
|
+
#Include a locale on a collection of keys
|
441
|
+
result = api_instance.keys_include(project_id, keys_include_parameters, opts)
|
442
|
+
pp result
|
443
|
+
rescue Phrase::ApiError => e
|
444
|
+
puts "Exception when calling KeysApi->keys_include: #{e}"
|
445
|
+
end
|
446
|
+
```
|
447
|
+
|
448
|
+
### Parameters
|
449
|
+
|
450
|
+
|
451
|
+
Name | Type | Description | Notes
|
452
|
+
------------- | ------------- | ------------- | -------------
|
453
|
+
**project_id** | **String**| Project ID |
|
454
|
+
**keys_include_parameters** | [**KeysIncludeParameters**](KeysIncludeParameters.md)| |
|
455
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
456
|
+
|
457
|
+
### Return type
|
458
|
+
|
459
|
+
Response<([**AffectedResources**](AffectedResources.md))>
|
460
|
+
|
461
|
+
### Authorization
|
462
|
+
|
463
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
464
|
+
|
465
|
+
### HTTP request headers
|
466
|
+
|
467
|
+
- **Content-Type**: application/json
|
468
|
+
- **Accept**: application/json
|
469
|
+
|
470
|
+
|
343
471
|
## keys_list
|
344
472
|
|
345
473
|
> Array<TranslationKey> keys_list(project_id, opts)
|
@@ -373,7 +501,7 @@ opts = {
|
|
373
501
|
branch: 'my-feature-branch', # String | specify the branch to use
|
374
502
|
sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
|
375
503
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
376
|
-
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names -
|
504
|
+
q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
377
505
|
locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
378
506
|
}
|
379
507
|
|
@@ -398,7 +526,7 @@ Name | Type | Description | Notes
|
|
398
526
|
**branch** | **String**| specify the branch to use | [optional]
|
399
527
|
**sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional]
|
400
528
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
401
|
-
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names -
|
529
|
+
**q** | **String**| Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
402
530
|
**locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
403
531
|
|
404
532
|
### Return type
|