phrase 1.0.13 → 2.2.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 +48 -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/JobCreateParameters.md +2 -0
- data/docs/JobDetails.md +2 -0
- data/docs/JobDetails1.md +2 -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/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/lib/phrase.rb +24 -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/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_create_parameters.rb +11 -1
- data/lib/phrase/models/job_details.rb +10 -1
- data/lib/phrase/models/job_details1.rb +10 -1
- 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/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/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/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_create_parameters_spec.rb +6 -0
- data/spec/models/job_details1_spec.rb +6 -0
- data/spec/models/job_details_spec.rb +6 -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/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
- metadata +263 -167
@@ -0,0 +1,23 @@
|
|
1
|
+
# Phrase::JobTemplateLocale
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**job_template** | [**JobTemplatePreview**](JobTemplatePreview.md) | | [optional]
|
9
|
+
**locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
10
|
+
**users** | [**Array<JobTemplateUserPreview>**](JobTemplateUserPreview.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'Phrase'
|
16
|
+
|
17
|
+
instance = Phrase::JobTemplateLocale.new(id: null,
|
18
|
+
job_template: null,
|
19
|
+
locale: null,
|
20
|
+
users: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# Phrase::JobTemplateLocaleUpdateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
8
|
+
**locale_id** | **String** | locale id |
|
9
|
+
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job template locale | [optional]
|
10
|
+
**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job template locale | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'Phrase'
|
16
|
+
|
17
|
+
instance = Phrase::JobTemplateLocaleUpdateParameters.new(branch: my-feature-branch,
|
18
|
+
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
19
|
+
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
20
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,347 @@
|
|
1
|
+
# Phrase::JobTemplateLocalesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**job_template_locale_delete**](JobTemplateLocalesApi.md#job_template_locale_delete) | **DELETE** /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Delete a job template locale
|
8
|
+
[**job_template_locale_show**](JobTemplateLocalesApi.md#job_template_locale_show) | **GET** /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Get a single job template locale
|
9
|
+
[**job_template_locale_update**](JobTemplateLocalesApi.md#job_template_locale_update) | **PATCH** /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Update a job template locale
|
10
|
+
[**job_template_locales_create**](JobTemplateLocalesApi.md#job_template_locales_create) | **POST** /projects/{project_id}/job_templates/{job_template_id}/locales | Create a job template locale
|
11
|
+
[**job_template_locales_list**](JobTemplateLocalesApi.md#job_template_locales_list) | **GET** /projects/{project_id}/job_templates/{job_template_id}/locales | List job template locales
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
## job_template_locale_delete
|
16
|
+
|
17
|
+
> job_template_locale_delete(project_id, job_template_id, job_template_locale_id, opts)
|
18
|
+
|
19
|
+
Delete a job template locale
|
20
|
+
|
21
|
+
Delete an existing job template locale.
|
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::JobTemplateLocalesApi.new
|
40
|
+
project_id = 'project_id_example' # String | Project ID
|
41
|
+
job_template_id = 'job_template_id_example' # String | Job Template ID
|
42
|
+
job_template_locale_id = 'job_template_locale_id_example' # String | Job Template Locale ID
|
43
|
+
opts = {
|
44
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
45
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
46
|
+
}
|
47
|
+
|
48
|
+
begin
|
49
|
+
#Delete a job template locale
|
50
|
+
api_instance.job_template_locale_delete(project_id, job_template_id, job_template_locale_id, opts)
|
51
|
+
rescue Phrase::ApiError => e
|
52
|
+
puts "Exception when calling JobTemplateLocalesApi->job_template_locale_delete: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
|
59
|
+
Name | Type | Description | Notes
|
60
|
+
------------- | ------------- | ------------- | -------------
|
61
|
+
**project_id** | **String**| Project ID |
|
62
|
+
**job_template_id** | **String**| Job Template ID |
|
63
|
+
**job_template_locale_id** | **String**| Job Template Locale ID |
|
64
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
65
|
+
**branch** | **String**| specify the branch to use | [optional]
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
Response<(nil (empty response body))>
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: Not defined
|
79
|
+
|
80
|
+
|
81
|
+
## job_template_locale_show
|
82
|
+
|
83
|
+
> Object job_template_locale_show(project_id, job_template_id, job_template_locale_id, opts)
|
84
|
+
|
85
|
+
Get a single job template locale
|
86
|
+
|
87
|
+
Get a single job template locale for a given job template.
|
88
|
+
|
89
|
+
### Example
|
90
|
+
|
91
|
+
```ruby
|
92
|
+
# load the gem
|
93
|
+
require 'phrase'
|
94
|
+
# setup authorization
|
95
|
+
Phrase.configure do |config|
|
96
|
+
# Configure HTTP basic authorization: Basic
|
97
|
+
config.username = 'YOUR USERNAME'
|
98
|
+
config.password = 'YOUR PASSWORD'
|
99
|
+
|
100
|
+
# Configure API key authorization: Token
|
101
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
102
|
+
config.api_key_prefix['Authorization'] = 'token'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = Phrase::JobTemplateLocalesApi.new
|
106
|
+
project_id = 'project_id_example' # String | Project ID
|
107
|
+
job_template_id = 'job_template_id_example' # String | Job Template ID
|
108
|
+
job_template_locale_id = 'job_template_locale_id_example' # String | Job Template Locale ID
|
109
|
+
opts = {
|
110
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
111
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
112
|
+
}
|
113
|
+
|
114
|
+
begin
|
115
|
+
#Get a single job template locale
|
116
|
+
result = api_instance.job_template_locale_show(project_id, job_template_id, job_template_locale_id, opts)
|
117
|
+
pp result
|
118
|
+
rescue Phrase::ApiError => e
|
119
|
+
puts "Exception when calling JobTemplateLocalesApi->job_template_locale_show: #{e}"
|
120
|
+
end
|
121
|
+
```
|
122
|
+
|
123
|
+
### Parameters
|
124
|
+
|
125
|
+
|
126
|
+
Name | Type | Description | Notes
|
127
|
+
------------- | ------------- | ------------- | -------------
|
128
|
+
**project_id** | **String**| Project ID |
|
129
|
+
**job_template_id** | **String**| Job Template ID |
|
130
|
+
**job_template_locale_id** | **String**| Job Template Locale ID |
|
131
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
132
|
+
**branch** | **String**| specify the branch to use | [optional]
|
133
|
+
|
134
|
+
### Return type
|
135
|
+
|
136
|
+
Response<(**Object**)>
|
137
|
+
|
138
|
+
### Authorization
|
139
|
+
|
140
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
141
|
+
|
142
|
+
### HTTP request headers
|
143
|
+
|
144
|
+
- **Content-Type**: Not defined
|
145
|
+
- **Accept**: application/json
|
146
|
+
|
147
|
+
|
148
|
+
## job_template_locale_update
|
149
|
+
|
150
|
+
> Object job_template_locale_update(project_id, job_template_id, job_template_locale_id, job_template_locale_update_parameters, opts)
|
151
|
+
|
152
|
+
Update a job template locale
|
153
|
+
|
154
|
+
Update an existing job template locale.
|
155
|
+
|
156
|
+
### Example
|
157
|
+
|
158
|
+
```ruby
|
159
|
+
# load the gem
|
160
|
+
require 'phrase'
|
161
|
+
# setup authorization
|
162
|
+
Phrase.configure do |config|
|
163
|
+
# Configure HTTP basic authorization: Basic
|
164
|
+
config.username = 'YOUR USERNAME'
|
165
|
+
config.password = 'YOUR PASSWORD'
|
166
|
+
|
167
|
+
# Configure API key authorization: Token
|
168
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
169
|
+
config.api_key_prefix['Authorization'] = 'token'
|
170
|
+
end
|
171
|
+
|
172
|
+
api_instance = Phrase::JobTemplateLocalesApi.new
|
173
|
+
project_id = 'project_id_example' # String | Project ID
|
174
|
+
job_template_id = 'job_template_id_example' # String | Job Template ID
|
175
|
+
job_template_locale_id = 'job_template_locale_id_example' # String | Job Template Locale ID
|
176
|
+
job_template_locale_update_parameters = Phrase::JobTemplateLocaleUpdateParameters.new # JobTemplateLocaleUpdateParameters |
|
177
|
+
opts = {
|
178
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
179
|
+
}
|
180
|
+
|
181
|
+
begin
|
182
|
+
#Update a job template locale
|
183
|
+
result = api_instance.job_template_locale_update(project_id, job_template_id, job_template_locale_id, job_template_locale_update_parameters, opts)
|
184
|
+
pp result
|
185
|
+
rescue Phrase::ApiError => e
|
186
|
+
puts "Exception when calling JobTemplateLocalesApi->job_template_locale_update: #{e}"
|
187
|
+
end
|
188
|
+
```
|
189
|
+
|
190
|
+
### Parameters
|
191
|
+
|
192
|
+
|
193
|
+
Name | Type | Description | Notes
|
194
|
+
------------- | ------------- | ------------- | -------------
|
195
|
+
**project_id** | **String**| Project ID |
|
196
|
+
**job_template_id** | **String**| Job Template ID |
|
197
|
+
**job_template_locale_id** | **String**| Job Template Locale ID |
|
198
|
+
**job_template_locale_update_parameters** | [**JobTemplateLocaleUpdateParameters**](JobTemplateLocaleUpdateParameters.md)| |
|
199
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
200
|
+
|
201
|
+
### Return type
|
202
|
+
|
203
|
+
Response<(**Object**)>
|
204
|
+
|
205
|
+
### Authorization
|
206
|
+
|
207
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
208
|
+
|
209
|
+
### HTTP request headers
|
210
|
+
|
211
|
+
- **Content-Type**: application/json
|
212
|
+
- **Accept**: application/json
|
213
|
+
|
214
|
+
|
215
|
+
## job_template_locales_create
|
216
|
+
|
217
|
+
> JobTemplateLocale job_template_locales_create(project_id, job_template_id, job_template_locales_create_parameters, opts)
|
218
|
+
|
219
|
+
Create a job template locale
|
220
|
+
|
221
|
+
Create a new job template locale.
|
222
|
+
|
223
|
+
### Example
|
224
|
+
|
225
|
+
```ruby
|
226
|
+
# load the gem
|
227
|
+
require 'phrase'
|
228
|
+
# setup authorization
|
229
|
+
Phrase.configure do |config|
|
230
|
+
# Configure HTTP basic authorization: Basic
|
231
|
+
config.username = 'YOUR USERNAME'
|
232
|
+
config.password = 'YOUR PASSWORD'
|
233
|
+
|
234
|
+
# Configure API key authorization: Token
|
235
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
236
|
+
config.api_key_prefix['Authorization'] = 'token'
|
237
|
+
end
|
238
|
+
|
239
|
+
api_instance = Phrase::JobTemplateLocalesApi.new
|
240
|
+
project_id = 'project_id_example' # String | Project ID
|
241
|
+
job_template_id = 'job_template_id_example' # String | Job Template ID
|
242
|
+
job_template_locales_create_parameters = Phrase::JobTemplateLocalesCreateParameters.new # JobTemplateLocalesCreateParameters |
|
243
|
+
opts = {
|
244
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
245
|
+
}
|
246
|
+
|
247
|
+
begin
|
248
|
+
#Create a job template locale
|
249
|
+
result = api_instance.job_template_locales_create(project_id, job_template_id, job_template_locales_create_parameters, opts)
|
250
|
+
pp result
|
251
|
+
rescue Phrase::ApiError => e
|
252
|
+
puts "Exception when calling JobTemplateLocalesApi->job_template_locales_create: #{e}"
|
253
|
+
end
|
254
|
+
```
|
255
|
+
|
256
|
+
### Parameters
|
257
|
+
|
258
|
+
|
259
|
+
Name | Type | Description | Notes
|
260
|
+
------------- | ------------- | ------------- | -------------
|
261
|
+
**project_id** | **String**| Project ID |
|
262
|
+
**job_template_id** | **String**| Job Template ID |
|
263
|
+
**job_template_locales_create_parameters** | [**JobTemplateLocalesCreateParameters**](JobTemplateLocalesCreateParameters.md)| |
|
264
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
265
|
+
|
266
|
+
### Return type
|
267
|
+
|
268
|
+
Response<([**JobTemplateLocale**](JobTemplateLocale.md))>
|
269
|
+
|
270
|
+
### Authorization
|
271
|
+
|
272
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
273
|
+
|
274
|
+
### HTTP request headers
|
275
|
+
|
276
|
+
- **Content-Type**: application/json
|
277
|
+
- **Accept**: application/json
|
278
|
+
|
279
|
+
|
280
|
+
## job_template_locales_list
|
281
|
+
|
282
|
+
> Array<Object> job_template_locales_list(project_id, job_template_id, opts)
|
283
|
+
|
284
|
+
List job template locales
|
285
|
+
|
286
|
+
List all job template locales for a given job template.
|
287
|
+
|
288
|
+
### Example
|
289
|
+
|
290
|
+
```ruby
|
291
|
+
# load the gem
|
292
|
+
require 'phrase'
|
293
|
+
# setup authorization
|
294
|
+
Phrase.configure do |config|
|
295
|
+
# Configure HTTP basic authorization: Basic
|
296
|
+
config.username = 'YOUR USERNAME'
|
297
|
+
config.password = 'YOUR PASSWORD'
|
298
|
+
|
299
|
+
# Configure API key authorization: Token
|
300
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
301
|
+
config.api_key_prefix['Authorization'] = 'token'
|
302
|
+
end
|
303
|
+
|
304
|
+
api_instance = Phrase::JobTemplateLocalesApi.new
|
305
|
+
project_id = 'project_id_example' # String | Project ID
|
306
|
+
job_template_id = 'job_template_id_example' # String | Job Template ID
|
307
|
+
opts = {
|
308
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
309
|
+
page: 1, # Integer | Page number
|
310
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
311
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
312
|
+
}
|
313
|
+
|
314
|
+
begin
|
315
|
+
#List job template locales
|
316
|
+
result = api_instance.job_template_locales_list(project_id, job_template_id, opts)
|
317
|
+
pp result
|
318
|
+
rescue Phrase::ApiError => e
|
319
|
+
puts "Exception when calling JobTemplateLocalesApi->job_template_locales_list: #{e}"
|
320
|
+
end
|
321
|
+
```
|
322
|
+
|
323
|
+
### Parameters
|
324
|
+
|
325
|
+
|
326
|
+
Name | Type | Description | Notes
|
327
|
+
------------- | ------------- | ------------- | -------------
|
328
|
+
**project_id** | **String**| Project ID |
|
329
|
+
**job_template_id** | **String**| Job Template ID |
|
330
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
331
|
+
**page** | **Integer**| Page number | [optional]
|
332
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
333
|
+
**branch** | **String**| specify the branch to use | [optional]
|
334
|
+
|
335
|
+
### Return type
|
336
|
+
|
337
|
+
Response<(**Array<Object>**)>
|
338
|
+
|
339
|
+
### Authorization
|
340
|
+
|
341
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
342
|
+
|
343
|
+
### HTTP request headers
|
344
|
+
|
345
|
+
- **Content-Type**: Not defined
|
346
|
+
- **Accept**: application/json
|
347
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# Phrase::JobTemplateLocalesCreateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
8
|
+
**locale_id** | **String** | locale id |
|
9
|
+
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job template locale | [optional]
|
10
|
+
**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job template locale | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'Phrase'
|
16
|
+
|
17
|
+
instance = Phrase::JobTemplateLocalesCreateParameters.new(branch: my-feature-branch,
|
18
|
+
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
19
|
+
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
20
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::JobTemplatePreview
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::JobTemplatePreview.new(id: null,
|
16
|
+
name: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Phrase::JobTemplateUpdateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**branch** | **String** | specify the branch to use | [optional]
|
8
|
+
**name** | **String** | Job template name |
|
9
|
+
**briefing** | **String** | Briefing for the translators | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'Phrase'
|
15
|
+
|
16
|
+
instance = Phrase::JobTemplateUpdateParameters.new(branch: my-feature-branch,
|
17
|
+
name: template,
|
18
|
+
briefing: text)
|
19
|
+
```
|
20
|
+
|
21
|
+
|