phrase 2.8.7 → 2.9.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 +19 -3
- 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/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/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/version.rb +1 -1
- data/lib/phrase.rb +8 -0
- 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/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
- metadata +34 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fa22f134a6c2fff285e1b8156f8996425ad5fb1ca2c200d53716432d807c39df
|
4
|
+
data.tar.gz: 4d1ff0a13cb19365df3595b46b0279fe8ac57354667cc036604ed7c787f30b85
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3b4e276e204df624cec6c4afba2d4d67fdaa48df9b8620fcf7149362aaa5af42d6b58a7af02db33f66858658cb7a7da859645ba312999b45adf71ea6be00a34a
|
7
|
+
data.tar.gz: 3a7640bdf6629aa6bd05f923be402f08834235d02b61a12ce4b5bc5d084048da5e5dfc3450243df95fc35f7f0b97c95a352433fe0e32ace3634f8bf03f473827
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
|
|
7
7
|
## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 2.
|
10
|
+
- Package version: 2.9.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
|
13
13
|
|
@@ -56,10 +56,10 @@ gem build phrase.gemspec
|
|
56
56
|
Then install the gem locally:
|
57
57
|
|
58
58
|
```shell
|
59
|
-
gem install ./phrase-2.
|
59
|
+
gem install ./phrase-2.9.0.gem
|
60
60
|
```
|
61
61
|
|
62
|
-
(for development, run `gem install --dev ./phrase-2.
|
62
|
+
(for development, run `gem install --dev ./phrase-2.9.0.gem` to install the development dependencies)
|
63
63
|
|
64
64
|
## Getting Started
|
65
65
|
|
@@ -268,6 +268,16 @@ Class | Method | HTTP request | Description
|
|
268
268
|
*Phrase::OrdersApi* | [**order_delete**](docs/OrdersApi.md#order_delete) | **DELETE** /projects/{project_id}/orders/{id} | Cancel an order
|
269
269
|
*Phrase::OrdersApi* | [**order_show**](docs/OrdersApi.md#order_show) | **GET** /projects/{project_id}/orders/{id} | Get a single order
|
270
270
|
*Phrase::OrdersApi* | [**orders_list**](docs/OrdersApi.md#orders_list) | **GET** /projects/{project_id}/orders | List orders
|
271
|
+
*Phrase::OrganizationJobTemplateLocalesApi* | [**organization_job_template_locale_delete**](docs/OrganizationJobTemplateLocalesApi.md#organization_job_template_locale_delete) | **DELETE** /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Delete an organization job template locale
|
272
|
+
*Phrase::OrganizationJobTemplateLocalesApi* | [**organization_job_template_locale_show**](docs/OrganizationJobTemplateLocalesApi.md#organization_job_template_locale_show) | **GET** /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Get a single organization job template locale
|
273
|
+
*Phrase::OrganizationJobTemplateLocalesApi* | [**organization_job_template_locale_update**](docs/OrganizationJobTemplateLocalesApi.md#organization_job_template_locale_update) | **PATCH** /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Update an organization job template locale
|
274
|
+
*Phrase::OrganizationJobTemplateLocalesApi* | [**organization_job_template_locales_create**](docs/OrganizationJobTemplateLocalesApi.md#organization_job_template_locales_create) | **POST** /accounts/{account_id}/job_templates/{job_template_id}/locales | Create an organization job template locale
|
275
|
+
*Phrase::OrganizationJobTemplateLocalesApi* | [**organization_job_template_locales_list**](docs/OrganizationJobTemplateLocalesApi.md#organization_job_template_locales_list) | **GET** /accounts/{account_id}/job_templates/{job_template_id}/locales | List organization job template locales
|
276
|
+
*Phrase::OrganizationJobTemplatesApi* | [**organization_job_template_create**](docs/OrganizationJobTemplatesApi.md#organization_job_template_create) | **POST** /accounts/{account_id}/job_templates | Create an organization job template
|
277
|
+
*Phrase::OrganizationJobTemplatesApi* | [**organization_job_template_delete**](docs/OrganizationJobTemplatesApi.md#organization_job_template_delete) | **DELETE** /accounts/{account_id}/job_templates/{id} | Delete an organization job template
|
278
|
+
*Phrase::OrganizationJobTemplatesApi* | [**organization_job_template_update**](docs/OrganizationJobTemplatesApi.md#organization_job_template_update) | **PATCH** /accounts/{account_id}/job_templates/{id} | Update an organization job template
|
279
|
+
*Phrase::OrganizationJobTemplatesApi* | [**organization_job_templates_list**](docs/OrganizationJobTemplatesApi.md#organization_job_templates_list) | **GET** /accounts/{account_id}/job_templates | List organization job templates
|
280
|
+
*Phrase::OrganizationJobTemplatesApi* | [**organization_job_templates_show**](docs/OrganizationJobTemplatesApi.md#organization_job_templates_show) | **GET** /accounts/{account_id}/job_templates/{id} | Get a single organization job template
|
271
281
|
*Phrase::ProjectsApi* | [**project_create**](docs/ProjectsApi.md#project_create) | **POST** /projects | Create a project
|
272
282
|
*Phrase::ProjectsApi* | [**project_delete**](docs/ProjectsApi.md#project_delete) | **DELETE** /projects/{id} | Delete a project
|
273
283
|
*Phrase::ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
|
@@ -474,6 +484,12 @@ Class | Method | HTTP request | Description
|
|
474
484
|
- [Phrase::NotificationGroupDetail](docs/NotificationGroupDetail.md)
|
475
485
|
- [Phrase::OrderConfirmParameters](docs/OrderConfirmParameters.md)
|
476
486
|
- [Phrase::OrderCreateParameters](docs/OrderCreateParameters.md)
|
487
|
+
- [Phrase::OrganizationJobTemplate](docs/OrganizationJobTemplate.md)
|
488
|
+
- [Phrase::OrganizationJobTemplateCreateParameters](docs/OrganizationJobTemplateCreateParameters.md)
|
489
|
+
- [Phrase::OrganizationJobTemplateDetails](docs/OrganizationJobTemplateDetails.md)
|
490
|
+
- [Phrase::OrganizationJobTemplateLocaleUpdateParameters](docs/OrganizationJobTemplateLocaleUpdateParameters.md)
|
491
|
+
- [Phrase::OrganizationJobTemplateLocalesCreateParameters](docs/OrganizationJobTemplateLocalesCreateParameters.md)
|
492
|
+
- [Phrase::OrganizationJobTemplateUpdateParameters](docs/OrganizationJobTemplateUpdateParameters.md)
|
477
493
|
- [Phrase::Project](docs/Project.md)
|
478
494
|
- [Phrase::ProjectCreateParameters](docs/ProjectCreateParameters.md)
|
479
495
|
- [Phrase::ProjectDetails](docs/ProjectDetails.md)
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# Phrase::OrganizationJobTemplate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**briefing** | **String** | | [optional]
|
10
|
+
**created_at** | **DateTime** | | [optional]
|
11
|
+
**updated_at** | **DateTime** | | [optional]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'Phrase'
|
17
|
+
|
18
|
+
instance = Phrase::OrganizationJobTemplate.new(id: null,
|
19
|
+
name: null,
|
20
|
+
briefing: null,
|
21
|
+
created_at: null,
|
22
|
+
updated_at: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::OrganizationJobTemplateCreateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Job template name |
|
8
|
+
**briefing** | **String** | Briefing for the translators | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::OrganizationJobTemplateCreateParameters.new(name: template,
|
16
|
+
briefing: text)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# Phrase::OrganizationJobTemplateDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**briefing** | **String** | | [optional]
|
10
|
+
**created_at** | **DateTime** | | [optional]
|
11
|
+
**updated_at** | **DateTime** | | [optional]
|
12
|
+
**owner** | [**UserPreview**](UserPreview.md) | | [optional]
|
13
|
+
**creator** | [**UserPreview**](UserPreview.md) | | [optional]
|
14
|
+
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'Phrase'
|
20
|
+
|
21
|
+
instance = Phrase::OrganizationJobTemplateDetails.new(id: null,
|
22
|
+
name: null,
|
23
|
+
briefing: null,
|
24
|
+
created_at: null,
|
25
|
+
updated_at: null,
|
26
|
+
owner: null,
|
27
|
+
creator: null,
|
28
|
+
locales: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# Phrase::OrganizationJobTemplateLocaleUpdateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**locale_name** | **String** | locale name | [optional]
|
8
|
+
**locale_code** | **String** | locale code | [optional]
|
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
|
+
**translator_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as translators | [optional]
|
12
|
+
**reviewer_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as reviewers | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'Phrase'
|
18
|
+
|
19
|
+
instance = Phrase::OrganizationJobTemplateLocaleUpdateParameters.new(locale_name: de-1,
|
20
|
+
locale_code: de-DE,
|
21
|
+
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
22
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
23
|
+
translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
24
|
+
reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,341 @@
|
|
1
|
+
# Phrase::OrganizationJobTemplateLocalesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**organization_job_template_locale_delete**](OrganizationJobTemplateLocalesApi.md#organization_job_template_locale_delete) | **DELETE** /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Delete an organization job template locale
|
8
|
+
[**organization_job_template_locale_show**](OrganizationJobTemplateLocalesApi.md#organization_job_template_locale_show) | **GET** /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Get a single organization job template locale
|
9
|
+
[**organization_job_template_locale_update**](OrganizationJobTemplateLocalesApi.md#organization_job_template_locale_update) | **PATCH** /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} | Update an organization job template locale
|
10
|
+
[**organization_job_template_locales_create**](OrganizationJobTemplateLocalesApi.md#organization_job_template_locales_create) | **POST** /accounts/{account_id}/job_templates/{job_template_id}/locales | Create an organization job template locale
|
11
|
+
[**organization_job_template_locales_list**](OrganizationJobTemplateLocalesApi.md#organization_job_template_locales_list) | **GET** /accounts/{account_id}/job_templates/{job_template_id}/locales | List organization job template locales
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
## organization_job_template_locale_delete
|
16
|
+
|
17
|
+
> organization_job_template_locale_delete(account_id, job_template_id, job_template_locale_id, opts)
|
18
|
+
|
19
|
+
Delete an organization job template locale
|
20
|
+
|
21
|
+
Delete an existing organization 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::OrganizationJobTemplateLocalesApi.new
|
40
|
+
account_id = 'account_id_example' # String | Account 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
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
#Delete an organization job template locale
|
49
|
+
api_instance.organization_job_template_locale_delete(account_id, job_template_id, job_template_locale_id, opts)
|
50
|
+
rescue Phrase::ApiError => e
|
51
|
+
puts "Exception when calling OrganizationJobTemplateLocalesApi->organization_job_template_locale_delete: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**account_id** | **String**| Account ID |
|
61
|
+
**job_template_id** | **String**| Job Template ID |
|
62
|
+
**job_template_locale_id** | **String**| Job Template Locale ID |
|
63
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
64
|
+
|
65
|
+
### Return type
|
66
|
+
|
67
|
+
Response<(nil (empty response body))>
|
68
|
+
|
69
|
+
### Authorization
|
70
|
+
|
71
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
72
|
+
|
73
|
+
### HTTP request headers
|
74
|
+
|
75
|
+
- **Content-Type**: Not defined
|
76
|
+
- **Accept**: Not defined
|
77
|
+
|
78
|
+
|
79
|
+
## organization_job_template_locale_show
|
80
|
+
|
81
|
+
> JobTemplateLocales organization_job_template_locale_show(account_id, job_template_id, job_template_locale_id, opts)
|
82
|
+
|
83
|
+
Get a single organization job template locale
|
84
|
+
|
85
|
+
Get a single job template locale for a given organization job template.
|
86
|
+
|
87
|
+
### Example
|
88
|
+
|
89
|
+
```ruby
|
90
|
+
# load the gem
|
91
|
+
require 'phrase'
|
92
|
+
# setup authorization
|
93
|
+
Phrase.configure do |config|
|
94
|
+
# Configure HTTP basic authorization: Basic
|
95
|
+
config.username = 'YOUR USERNAME'
|
96
|
+
config.password = 'YOUR PASSWORD'
|
97
|
+
|
98
|
+
# Configure API key authorization: Token
|
99
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
100
|
+
config.api_key_prefix['Authorization'] = 'token'
|
101
|
+
end
|
102
|
+
|
103
|
+
api_instance = Phrase::OrganizationJobTemplateLocalesApi.new
|
104
|
+
account_id = 'account_id_example' # String | Account ID
|
105
|
+
job_template_id = 'job_template_id_example' # String | Job Template ID
|
106
|
+
job_template_locale_id = 'job_template_locale_id_example' # String | Job Template Locale ID
|
107
|
+
opts = {
|
108
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
109
|
+
}
|
110
|
+
|
111
|
+
begin
|
112
|
+
#Get a single organization job template locale
|
113
|
+
result = api_instance.organization_job_template_locale_show(account_id, job_template_id, job_template_locale_id, opts)
|
114
|
+
pp result
|
115
|
+
rescue Phrase::ApiError => e
|
116
|
+
puts "Exception when calling OrganizationJobTemplateLocalesApi->organization_job_template_locale_show: #{e}"
|
117
|
+
end
|
118
|
+
```
|
119
|
+
|
120
|
+
### Parameters
|
121
|
+
|
122
|
+
|
123
|
+
Name | Type | Description | Notes
|
124
|
+
------------- | ------------- | ------------- | -------------
|
125
|
+
**account_id** | **String**| Account ID |
|
126
|
+
**job_template_id** | **String**| Job Template ID |
|
127
|
+
**job_template_locale_id** | **String**| Job Template Locale ID |
|
128
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
129
|
+
|
130
|
+
### Return type
|
131
|
+
|
132
|
+
Response<([**JobTemplateLocales**](JobTemplateLocales.md))>
|
133
|
+
|
134
|
+
### Authorization
|
135
|
+
|
136
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
137
|
+
|
138
|
+
### HTTP request headers
|
139
|
+
|
140
|
+
- **Content-Type**: Not defined
|
141
|
+
- **Accept**: application/json
|
142
|
+
|
143
|
+
|
144
|
+
## organization_job_template_locale_update
|
145
|
+
|
146
|
+
> JobTemplateLocales organization_job_template_locale_update(account_id, job_template_id, job_template_locale_id, organization_job_template_locale_update_parameters, opts)
|
147
|
+
|
148
|
+
Update an organization job template locale
|
149
|
+
|
150
|
+
Update an existing organization job template locale.
|
151
|
+
|
152
|
+
### Example
|
153
|
+
|
154
|
+
```ruby
|
155
|
+
# load the gem
|
156
|
+
require 'phrase'
|
157
|
+
# setup authorization
|
158
|
+
Phrase.configure do |config|
|
159
|
+
# Configure HTTP basic authorization: Basic
|
160
|
+
config.username = 'YOUR USERNAME'
|
161
|
+
config.password = 'YOUR PASSWORD'
|
162
|
+
|
163
|
+
# Configure API key authorization: Token
|
164
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
165
|
+
config.api_key_prefix['Authorization'] = 'token'
|
166
|
+
end
|
167
|
+
|
168
|
+
api_instance = Phrase::OrganizationJobTemplateLocalesApi.new
|
169
|
+
account_id = 'account_id_example' # String | Account ID
|
170
|
+
job_template_id = 'job_template_id_example' # String | Job Template ID
|
171
|
+
job_template_locale_id = 'job_template_locale_id_example' # String | Job Template Locale ID
|
172
|
+
organization_job_template_locale_update_parameters = Phrase::OrganizationJobTemplateLocaleUpdateParameters.new # OrganizationJobTemplateLocaleUpdateParameters |
|
173
|
+
opts = {
|
174
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
175
|
+
}
|
176
|
+
|
177
|
+
begin
|
178
|
+
#Update an organization job template locale
|
179
|
+
result = api_instance.organization_job_template_locale_update(account_id, job_template_id, job_template_locale_id, organization_job_template_locale_update_parameters, opts)
|
180
|
+
pp result
|
181
|
+
rescue Phrase::ApiError => e
|
182
|
+
puts "Exception when calling OrganizationJobTemplateLocalesApi->organization_job_template_locale_update: #{e}"
|
183
|
+
end
|
184
|
+
```
|
185
|
+
|
186
|
+
### Parameters
|
187
|
+
|
188
|
+
|
189
|
+
Name | Type | Description | Notes
|
190
|
+
------------- | ------------- | ------------- | -------------
|
191
|
+
**account_id** | **String**| Account ID |
|
192
|
+
**job_template_id** | **String**| Job Template ID |
|
193
|
+
**job_template_locale_id** | **String**| Job Template Locale ID |
|
194
|
+
**organization_job_template_locale_update_parameters** | [**OrganizationJobTemplateLocaleUpdateParameters**](OrganizationJobTemplateLocaleUpdateParameters.md)| |
|
195
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
196
|
+
|
197
|
+
### Return type
|
198
|
+
|
199
|
+
Response<([**JobTemplateLocales**](JobTemplateLocales.md))>
|
200
|
+
|
201
|
+
### Authorization
|
202
|
+
|
203
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
204
|
+
|
205
|
+
### HTTP request headers
|
206
|
+
|
207
|
+
- **Content-Type**: application/json
|
208
|
+
- **Accept**: application/json
|
209
|
+
|
210
|
+
|
211
|
+
## organization_job_template_locales_create
|
212
|
+
|
213
|
+
> JobTemplateLocales organization_job_template_locales_create(account_id, job_template_id, organization_job_template_locales_create_parameters, opts)
|
214
|
+
|
215
|
+
Create an organization job template locale
|
216
|
+
|
217
|
+
Create a new organization job template locale.
|
218
|
+
|
219
|
+
### Example
|
220
|
+
|
221
|
+
```ruby
|
222
|
+
# load the gem
|
223
|
+
require 'phrase'
|
224
|
+
# setup authorization
|
225
|
+
Phrase.configure do |config|
|
226
|
+
# Configure HTTP basic authorization: Basic
|
227
|
+
config.username = 'YOUR USERNAME'
|
228
|
+
config.password = 'YOUR PASSWORD'
|
229
|
+
|
230
|
+
# Configure API key authorization: Token
|
231
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
232
|
+
config.api_key_prefix['Authorization'] = 'token'
|
233
|
+
end
|
234
|
+
|
235
|
+
api_instance = Phrase::OrganizationJobTemplateLocalesApi.new
|
236
|
+
account_id = 'account_id_example' # String | Account ID
|
237
|
+
job_template_id = 'job_template_id_example' # String | Job Template ID
|
238
|
+
organization_job_template_locales_create_parameters = Phrase::OrganizationJobTemplateLocalesCreateParameters.new # OrganizationJobTemplateLocalesCreateParameters |
|
239
|
+
opts = {
|
240
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
241
|
+
}
|
242
|
+
|
243
|
+
begin
|
244
|
+
#Create an organization job template locale
|
245
|
+
result = api_instance.organization_job_template_locales_create(account_id, job_template_id, organization_job_template_locales_create_parameters, opts)
|
246
|
+
pp result
|
247
|
+
rescue Phrase::ApiError => e
|
248
|
+
puts "Exception when calling OrganizationJobTemplateLocalesApi->organization_job_template_locales_create: #{e}"
|
249
|
+
end
|
250
|
+
```
|
251
|
+
|
252
|
+
### Parameters
|
253
|
+
|
254
|
+
|
255
|
+
Name | Type | Description | Notes
|
256
|
+
------------- | ------------- | ------------- | -------------
|
257
|
+
**account_id** | **String**| Account ID |
|
258
|
+
**job_template_id** | **String**| Job Template ID |
|
259
|
+
**organization_job_template_locales_create_parameters** | [**OrganizationJobTemplateLocalesCreateParameters**](OrganizationJobTemplateLocalesCreateParameters.md)| |
|
260
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
261
|
+
|
262
|
+
### Return type
|
263
|
+
|
264
|
+
Response<([**JobTemplateLocales**](JobTemplateLocales.md))>
|
265
|
+
|
266
|
+
### Authorization
|
267
|
+
|
268
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
269
|
+
|
270
|
+
### HTTP request headers
|
271
|
+
|
272
|
+
- **Content-Type**: application/json
|
273
|
+
- **Accept**: application/json
|
274
|
+
|
275
|
+
|
276
|
+
## organization_job_template_locales_list
|
277
|
+
|
278
|
+
> Array<JobTemplateLocales> organization_job_template_locales_list(account_id, job_template_id, opts)
|
279
|
+
|
280
|
+
List organization job template locales
|
281
|
+
|
282
|
+
List all job template locales for a given organization job template.
|
283
|
+
|
284
|
+
### Example
|
285
|
+
|
286
|
+
```ruby
|
287
|
+
# load the gem
|
288
|
+
require 'phrase'
|
289
|
+
# setup authorization
|
290
|
+
Phrase.configure do |config|
|
291
|
+
# Configure HTTP basic authorization: Basic
|
292
|
+
config.username = 'YOUR USERNAME'
|
293
|
+
config.password = 'YOUR PASSWORD'
|
294
|
+
|
295
|
+
# Configure API key authorization: Token
|
296
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
297
|
+
config.api_key_prefix['Authorization'] = 'token'
|
298
|
+
end
|
299
|
+
|
300
|
+
api_instance = Phrase::OrganizationJobTemplateLocalesApi.new
|
301
|
+
account_id = 'account_id_example' # String | Account ID
|
302
|
+
job_template_id = 'job_template_id_example' # String | Job Template ID
|
303
|
+
opts = {
|
304
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
305
|
+
page: 1, # Integer | Page number
|
306
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
307
|
+
}
|
308
|
+
|
309
|
+
begin
|
310
|
+
#List organization job template locales
|
311
|
+
result = api_instance.organization_job_template_locales_list(account_id, job_template_id, opts)
|
312
|
+
pp result
|
313
|
+
rescue Phrase::ApiError => e
|
314
|
+
puts "Exception when calling OrganizationJobTemplateLocalesApi->organization_job_template_locales_list: #{e}"
|
315
|
+
end
|
316
|
+
```
|
317
|
+
|
318
|
+
### Parameters
|
319
|
+
|
320
|
+
|
321
|
+
Name | Type | Description | Notes
|
322
|
+
------------- | ------------- | ------------- | -------------
|
323
|
+
**account_id** | **String**| Account ID |
|
324
|
+
**job_template_id** | **String**| Job Template ID |
|
325
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
326
|
+
**page** | **Integer**| Page number | [optional]
|
327
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
328
|
+
|
329
|
+
### Return type
|
330
|
+
|
331
|
+
Response<([**Array<JobTemplateLocales>**](JobTemplateLocales.md))>
|
332
|
+
|
333
|
+
### Authorization
|
334
|
+
|
335
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
336
|
+
|
337
|
+
### HTTP request headers
|
338
|
+
|
339
|
+
- **Content-Type**: Not defined
|
340
|
+
- **Accept**: application/json
|
341
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# Phrase::OrganizationJobTemplateLocalesCreateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**locale_name** | **String** | locale name |
|
8
|
+
**locale_code** | **String** | locale code |
|
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
|
+
**translator_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as translators | [optional]
|
12
|
+
**reviewer_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as reviewers | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'Phrase'
|
18
|
+
|
19
|
+
instance = Phrase::OrganizationJobTemplateLocalesCreateParameters.new(locale_name: de-1,
|
20
|
+
locale_code: de-DE,
|
21
|
+
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
22
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
23
|
+
translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
24
|
+
reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::OrganizationJobTemplateUpdateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Job template name |
|
8
|
+
**briefing** | **String** | Briefing for the translators | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::OrganizationJobTemplateUpdateParameters.new(name: template,
|
16
|
+
briefing: text)
|
17
|
+
```
|
18
|
+
|
19
|
+
|