phrase 2.0.0 → 2.1.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/README.md +41 -3
- 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/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 +132 -4
- 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 +68 -2
- 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/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/User.md +0 -2
- data/lib/phrase.rb +23 -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 +152 -4
- data/lib/phrase/api/locales_api.rb +71 -2
- 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/search_api.rb +84 -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/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/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 +30 -2
- data/spec/api/locales_api_spec.rb +16 -1
- 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/search_api_spec.rb +37 -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/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/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 +268 -176
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 57bcfe694573191aa565b5ba5713399a56a86c4b6935bf0b91cea89376fcfdaa
|
|
4
|
+
data.tar.gz: a4503e693ce8fdb3f1ae95b4443bc6830b2878161052f6e1373026fc0b6fc2cf
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0a501f83db9117887160dd71aa93e0460c1bb26e1fc18bd5fded00f3a33d9138510e8ebf8b20500fe34c9f86f13a8adbe79b48520918f8c0b7cd9e0fe36229f2
|
|
7
|
+
data.tar.gz: 07fadf4788775eb5f2f69151c90f138a0be72c0170ae092c411b182fecf36fc3282ed9dd61d686db81eb56d13ca1e104f46828a9bcd2113a8f0a6f73fddddbe9
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Phrase is a translation management platform for software projects. You can colla
|
|
|
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.1.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.1.0.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./phrase-2.
|
|
62
|
+
(for development, run `gem install --dev ./phrase-2.1.0.gem` to install the development dependencies)
|
|
63
63
|
|
|
64
64
|
## Getting Started
|
|
65
65
|
|
|
@@ -178,6 +178,16 @@ Class | Method | HTTP request | Description
|
|
|
178
178
|
*Phrase::JobLocalesApi* | [**job_locale_update**](docs/JobLocalesApi.md#job_locale_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{id} | Update a job locale
|
|
179
179
|
*Phrase::JobLocalesApi* | [**job_locales_create**](docs/JobLocalesApi.md#job_locales_create) | **POST** /projects/{project_id}/jobs/{job_id}/locales | Create a job locale
|
|
180
180
|
*Phrase::JobLocalesApi* | [**job_locales_list**](docs/JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job locales
|
|
181
|
+
*Phrase::JobTemplateLocalesApi* | [**job_template_locale_delete**](docs/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
|
|
182
|
+
*Phrase::JobTemplateLocalesApi* | [**job_template_locale_show**](docs/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
|
|
183
|
+
*Phrase::JobTemplateLocalesApi* | [**job_template_locale_update**](docs/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
|
|
184
|
+
*Phrase::JobTemplateLocalesApi* | [**job_template_locales_create**](docs/JobTemplateLocalesApi.md#job_template_locales_create) | **POST** /projects/{project_id}/job_templates/{job_template_id}/locales | Create a job template locale
|
|
185
|
+
*Phrase::JobTemplateLocalesApi* | [**job_template_locales_list**](docs/JobTemplateLocalesApi.md#job_template_locales_list) | **GET** /projects/{project_id}/job_templates/{job_template_id}/locales | List job template locales
|
|
186
|
+
*Phrase::JobTemplatesApi* | [**job_template_create**](docs/JobTemplatesApi.md#job_template_create) | **POST** /projects/{project_id}/job_templates | Create a job template
|
|
187
|
+
*Phrase::JobTemplatesApi* | [**job_template_delete**](docs/JobTemplatesApi.md#job_template_delete) | **DELETE** /projects/{project_id}/job_templates/{id} | Delete a job template
|
|
188
|
+
*Phrase::JobTemplatesApi* | [**job_template_show**](docs/JobTemplatesApi.md#job_template_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
|
|
189
|
+
*Phrase::JobTemplatesApi* | [**job_template_update**](docs/JobTemplatesApi.md#job_template_update) | **PATCH** /projects/{project_id}/job_templates/{id} | Update a job template
|
|
190
|
+
*Phrase::JobTemplatesApi* | [**job_templates_list**](docs/JobTemplatesApi.md#job_templates_list) | **GET** /projects/{project_id}/job_templates | List job templates
|
|
181
191
|
*Phrase::JobsApi* | [**job_complete**](docs/JobsApi.md#job_complete) | **POST** /projects/{project_id}/jobs/{id}/complete | Complete a job
|
|
182
192
|
*Phrase::JobsApi* | [**job_create**](docs/JobsApi.md#job_create) | **POST** /projects/{project_id}/jobs | Create a job
|
|
183
193
|
*Phrase::JobsApi* | [**job_delete**](docs/JobsApi.md#job_delete) | **DELETE** /projects/{project_id}/jobs/{id} | Delete a job
|
|
@@ -194,10 +204,13 @@ Class | Method | HTTP request | Description
|
|
|
194
204
|
*Phrase::KeysApi* | [**key_show**](docs/KeysApi.md#key_show) | **GET** /projects/{project_id}/keys/{id} | Get a single key
|
|
195
205
|
*Phrase::KeysApi* | [**key_update**](docs/KeysApi.md#key_update) | **PATCH** /projects/{project_id}/keys/{id} | Update a key
|
|
196
206
|
*Phrase::KeysApi* | [**keys_delete_collection**](docs/KeysApi.md#keys_delete_collection) | **DELETE** /projects/{project_id}/keys | Delete collection of keys
|
|
207
|
+
*Phrase::KeysApi* | [**keys_exclude**](docs/KeysApi.md#keys_exclude) | **PATCH** /projects/{project_id}/keys/exclude | Exclude a locale on a collection of keys
|
|
208
|
+
*Phrase::KeysApi* | [**keys_include**](docs/KeysApi.md#keys_include) | **PATCH** /projects/{project_id}/keys/include | Include a locale on a collection of keys
|
|
197
209
|
*Phrase::KeysApi* | [**keys_list**](docs/KeysApi.md#keys_list) | **GET** /projects/{project_id}/keys | List keys
|
|
198
210
|
*Phrase::KeysApi* | [**keys_search**](docs/KeysApi.md#keys_search) | **POST** /projects/{project_id}/keys/search | Search keys
|
|
199
211
|
*Phrase::KeysApi* | [**keys_tag**](docs/KeysApi.md#keys_tag) | **PATCH** /projects/{project_id}/keys/tag | Add tags to collection of keys
|
|
200
212
|
*Phrase::KeysApi* | [**keys_untag**](docs/KeysApi.md#keys_untag) | **PATCH** /projects/{project_id}/keys/untag | Remove tags from collection of keys
|
|
213
|
+
*Phrase::LocalesApi* | [**account_locales**](docs/LocalesApi.md#account_locales) | **GET** /accounts/{account_id}/locales | List locales used in account
|
|
201
214
|
*Phrase::LocalesApi* | [**locale_create**](docs/LocalesApi.md#locale_create) | **POST** /projects/{project_id}/locales | Create a locale
|
|
202
215
|
*Phrase::LocalesApi* | [**locale_delete**](docs/LocalesApi.md#locale_delete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale
|
|
203
216
|
*Phrase::LocalesApi* | [**locale_download**](docs/LocalesApi.md#locale_download) | **GET** /projects/{project_id}/locales/{id}/download | Download a locale
|
|
@@ -209,6 +222,12 @@ Class | Method | HTTP request | Description
|
|
|
209
222
|
*Phrase::MembersApi* | [**member_update**](docs/MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
|
|
210
223
|
*Phrase::MembersApi* | [**member_update_settings**](docs/MembersApi.md#member_update_settings) | **PATCH** /projects/{project_id}/members/{id} | Update a member's project settings
|
|
211
224
|
*Phrase::MembersApi* | [**members_list**](docs/MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
|
|
225
|
+
*Phrase::NotificationGroupsApi* | [**notification_groups_list**](docs/NotificationGroupsApi.md#notification_groups_list) | **GET** /notification_groups | List notification groups
|
|
226
|
+
*Phrase::NotificationGroupsApi* | [**notification_groups_mark_all_as_read**](docs/NotificationGroupsApi.md#notification_groups_mark_all_as_read) | **PATCH** /notification_groups/mark_all_as_read | Mark all notification groups as read
|
|
227
|
+
*Phrase::NotificationGroupsApi* | [**notification_groups_mark_as_read**](docs/NotificationGroupsApi.md#notification_groups_mark_as_read) | **PATCH** /notification_groups/{id}/mark_as_read | Mark a notification group as read
|
|
228
|
+
*Phrase::NotificationsApi* | [**notifications_list**](docs/NotificationsApi.md#notifications_list) | **GET** /notifications | List notifications
|
|
229
|
+
*Phrase::NotificationsApi* | [**notifications_mark_all_as_read**](docs/NotificationsApi.md#notifications_mark_all_as_read) | **POST** /notifications/mark_all_as_read | Mark all notifications as read
|
|
230
|
+
*Phrase::NotificationsApi* | [**notifications_show**](docs/NotificationsApi.md#notifications_show) | **GET** /notifications/{id} | Get a single notification
|
|
212
231
|
*Phrase::OrdersApi* | [**order_confirm**](docs/OrdersApi.md#order_confirm) | **PATCH** /projects/{project_id}/orders/{id}/confirm | Confirm an order
|
|
213
232
|
*Phrase::OrdersApi* | [**order_create**](docs/OrdersApi.md#order_create) | **POST** /projects/{project_id}/orders | Create a new order
|
|
214
233
|
*Phrase::OrdersApi* | [**order_delete**](docs/OrdersApi.md#order_delete) | **DELETE** /projects/{project_id}/orders/{id} | Cancel an order
|
|
@@ -235,6 +254,7 @@ Class | Method | HTTP request | Description
|
|
|
235
254
|
*Phrase::ScreenshotsApi* | [**screenshot_show**](docs/ScreenshotsApi.md#screenshot_show) | **GET** /projects/{project_id}/screenshots/{id} | Get a single screenshot
|
|
236
255
|
*Phrase::ScreenshotsApi* | [**screenshot_update**](docs/ScreenshotsApi.md#screenshot_update) | **PATCH** /projects/{project_id}/screenshots/{id} | Update a screenshot
|
|
237
256
|
*Phrase::ScreenshotsApi* | [**screenshots_list**](docs/ScreenshotsApi.md#screenshots_list) | **GET** /projects/{project_id}/screenshots | List screenshots
|
|
257
|
+
*Phrase::SearchApi* | [**search_in_account**](docs/SearchApi.md#search_in_account) | **POST** /accounts/{account_id}/search | Search across projects
|
|
238
258
|
*Phrase::SpacesApi* | [**space_create**](docs/SpacesApi.md#space_create) | **POST** /accounts/{account_id}/spaces | Create a Space
|
|
239
259
|
*Phrase::SpacesApi* | [**space_delete**](docs/SpacesApi.md#space_delete) | **DELETE** /accounts/{account_id}/spaces/{id} | Delete Space
|
|
240
260
|
*Phrase::SpacesApi* | [**space_show**](docs/SpacesApi.md#space_show) | **GET** /accounts/{account_id}/spaces/{id} | Get Space
|
|
@@ -304,6 +324,7 @@ Class | Method | HTTP request | Description
|
|
|
304
324
|
- [Phrase::Account](docs/Account.md)
|
|
305
325
|
- [Phrase::AccountDetails](docs/AccountDetails.md)
|
|
306
326
|
- [Phrase::AccountDetails1](docs/AccountDetails1.md)
|
|
327
|
+
- [Phrase::AccountSearchResult](docs/AccountSearchResult.md)
|
|
307
328
|
- [Phrase::AffectedCount](docs/AffectedCount.md)
|
|
308
329
|
- [Phrase::AffectedResources](docs/AffectedResources.md)
|
|
309
330
|
- [Phrase::Authorization](docs/Authorization.md)
|
|
@@ -370,10 +391,20 @@ Class | Method | HTTP request | Description
|
|
|
370
391
|
- [Phrase::JobPreview](docs/JobPreview.md)
|
|
371
392
|
- [Phrase::JobReopenParameters](docs/JobReopenParameters.md)
|
|
372
393
|
- [Phrase::JobStartParameters](docs/JobStartParameters.md)
|
|
394
|
+
- [Phrase::JobTemplate](docs/JobTemplate.md)
|
|
395
|
+
- [Phrase::JobTemplateCreateParameters](docs/JobTemplateCreateParameters.md)
|
|
396
|
+
- [Phrase::JobTemplateLocale](docs/JobTemplateLocale.md)
|
|
397
|
+
- [Phrase::JobTemplateLocaleUpdateParameters](docs/JobTemplateLocaleUpdateParameters.md)
|
|
398
|
+
- [Phrase::JobTemplateLocalesCreateParameters](docs/JobTemplateLocalesCreateParameters.md)
|
|
399
|
+
- [Phrase::JobTemplatePreview](docs/JobTemplatePreview.md)
|
|
400
|
+
- [Phrase::JobTemplateUpdateParameters](docs/JobTemplateUpdateParameters.md)
|
|
401
|
+
- [Phrase::JobTemplateUserPreview](docs/JobTemplateUserPreview.md)
|
|
373
402
|
- [Phrase::JobUpdateParameters](docs/JobUpdateParameters.md)
|
|
374
403
|
- [Phrase::KeyCreateParameters](docs/KeyCreateParameters.md)
|
|
375
404
|
- [Phrase::KeyPreview](docs/KeyPreview.md)
|
|
376
405
|
- [Phrase::KeyUpdateParameters](docs/KeyUpdateParameters.md)
|
|
406
|
+
- [Phrase::KeysExcludeParameters](docs/KeysExcludeParameters.md)
|
|
407
|
+
- [Phrase::KeysIncludeParameters](docs/KeysIncludeParameters.md)
|
|
377
408
|
- [Phrase::KeysSearchParameters](docs/KeysSearchParameters.md)
|
|
378
409
|
- [Phrase::KeysTagParameters](docs/KeysTagParameters.md)
|
|
379
410
|
- [Phrase::KeysUntagParameters](docs/KeysUntagParameters.md)
|
|
@@ -382,6 +413,7 @@ Class | Method | HTTP request | Description
|
|
|
382
413
|
- [Phrase::LocaleDetails](docs/LocaleDetails.md)
|
|
383
414
|
- [Phrase::LocaleDetails1](docs/LocaleDetails1.md)
|
|
384
415
|
- [Phrase::LocalePreview](docs/LocalePreview.md)
|
|
416
|
+
- [Phrase::LocalePreview1](docs/LocalePreview1.md)
|
|
385
417
|
- [Phrase::LocaleStatistics](docs/LocaleStatistics.md)
|
|
386
418
|
- [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
|
|
387
419
|
- [Phrase::Member](docs/Member.md)
|
|
@@ -390,6 +422,9 @@ Class | Method | HTTP request | Description
|
|
|
390
422
|
- [Phrase::MemberSpaces](docs/MemberSpaces.md)
|
|
391
423
|
- [Phrase::MemberUpdateParameters](docs/MemberUpdateParameters.md)
|
|
392
424
|
- [Phrase::MemberUpdateSettingsParameters](docs/MemberUpdateSettingsParameters.md)
|
|
425
|
+
- [Phrase::Notification](docs/Notification.md)
|
|
426
|
+
- [Phrase::NotificationGroup](docs/NotificationGroup.md)
|
|
427
|
+
- [Phrase::NotificationGroupDetail](docs/NotificationGroupDetail.md)
|
|
393
428
|
- [Phrase::OrderConfirmParameters](docs/OrderConfirmParameters.md)
|
|
394
429
|
- [Phrase::OrderCreateParameters](docs/OrderCreateParameters.md)
|
|
395
430
|
- [Phrase::Project](docs/Project.md)
|
|
@@ -410,7 +445,9 @@ Class | Method | HTTP request | Description
|
|
|
410
445
|
- [Phrase::ScreenshotMarkerCreateParameters](docs/ScreenshotMarkerCreateParameters.md)
|
|
411
446
|
- [Phrase::ScreenshotMarkerUpdateParameters](docs/ScreenshotMarkerUpdateParameters.md)
|
|
412
447
|
- [Phrase::ScreenshotUpdateParameters](docs/ScreenshotUpdateParameters.md)
|
|
448
|
+
- [Phrase::SearchInAccountParameters](docs/SearchInAccountParameters.md)
|
|
413
449
|
- [Phrase::Space](docs/Space.md)
|
|
450
|
+
- [Phrase::Space1](docs/Space1.md)
|
|
414
451
|
- [Phrase::SpaceCreateParameters](docs/SpaceCreateParameters.md)
|
|
415
452
|
- [Phrase::SpaceUpdateParameters](docs/SpaceUpdateParameters.md)
|
|
416
453
|
- [Phrase::SpacesProjectsCreateParameters](docs/SpacesProjectsCreateParameters.md)
|
|
@@ -420,6 +457,7 @@ Class | Method | HTTP request | Description
|
|
|
420
457
|
- [Phrase::StyleguideDetails1](docs/StyleguideDetails1.md)
|
|
421
458
|
- [Phrase::StyleguidePreview](docs/StyleguidePreview.md)
|
|
422
459
|
- [Phrase::StyleguideUpdateParameters](docs/StyleguideUpdateParameters.md)
|
|
460
|
+
- [Phrase::Subscription](docs/Subscription.md)
|
|
423
461
|
- [Phrase::Tag](docs/Tag.md)
|
|
424
462
|
- [Phrase::TagCreateParameters](docs/TagCreateParameters.md)
|
|
425
463
|
- [Phrase::TagWithStats](docs/TagWithStats.md)
|
data/docs/Account.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**company** | **String** | | [optional]
|
|
11
11
|
**created_at** | **DateTime** | | [optional]
|
|
12
12
|
**updated_at** | **DateTime** | | [optional]
|
|
13
|
+
**company_logo_url** | **String** | | [optional]
|
|
13
14
|
|
|
14
15
|
## Code Sample
|
|
15
16
|
|
|
@@ -21,7 +22,8 @@ instance = Phrase::Account.new(id: null,
|
|
|
21
22
|
slug: null,
|
|
22
23
|
company: null,
|
|
23
24
|
created_at: null,
|
|
24
|
-
updated_at: null
|
|
25
|
+
updated_at: null,
|
|
26
|
+
company_logo_url: null)
|
|
25
27
|
```
|
|
26
28
|
|
|
27
29
|
|
data/docs/AccountDetails.md
CHANGED
|
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**company** | **String** | | [optional]
|
|
11
11
|
**created_at** | **DateTime** | | [optional]
|
|
12
12
|
**updated_at** | **DateTime** | | [optional]
|
|
13
|
+
**company_logo_url** | **String** | | [optional]
|
|
14
|
+
**subscription** | [**Subscription**](Subscription.md) | | [optional]
|
|
13
15
|
|
|
14
16
|
## Code Sample
|
|
15
17
|
|
|
@@ -21,7 +23,9 @@ instance = Phrase::AccountDetails.new(id: null,
|
|
|
21
23
|
slug: null,
|
|
22
24
|
company: null,
|
|
23
25
|
created_at: null,
|
|
24
|
-
updated_at: null
|
|
26
|
+
updated_at: null,
|
|
27
|
+
company_logo_url: null,
|
|
28
|
+
subscription: null)
|
|
25
29
|
```
|
|
26
30
|
|
|
27
31
|
|
data/docs/AccountDetails1.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**subscription** | [**Subscription**](Subscription.md) | | [optional]
|
|
7
8
|
**slug** | **String** | | [optional]
|
|
8
9
|
|
|
9
10
|
## Code Sample
|
|
@@ -11,7 +12,8 @@ Name | Type | Description | Notes
|
|
|
11
12
|
```ruby
|
|
12
13
|
require 'Phrase'
|
|
13
14
|
|
|
14
|
-
instance = Phrase::AccountDetails1.new(
|
|
15
|
+
instance = Phrase::AccountDetails1.new(subscription: null,
|
|
16
|
+
slug: null)
|
|
15
17
|
```
|
|
16
18
|
|
|
17
19
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Phrase::AccountSearchResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**query** | **String** | | [optional]
|
|
8
|
+
**excerpt** | **String** | | [optional]
|
|
9
|
+
**key** | [**KeyPreview**](KeyPreview.md) | | [optional]
|
|
10
|
+
**locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
11
|
+
**project** | [**Project**](Project.md) | | [optional]
|
|
12
|
+
**translation** | [**Translation**](Translation.md) | | [optional]
|
|
13
|
+
**other_translations** | [**Array<Translation>**](Translation.md) | | [optional]
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'Phrase'
|
|
19
|
+
|
|
20
|
+
instance = Phrase::AccountSearchResult.new(query: null,
|
|
21
|
+
excerpt: null,
|
|
22
|
+
key: null,
|
|
23
|
+
locale: null,
|
|
24
|
+
project: null,
|
|
25
|
+
translation: null,
|
|
26
|
+
other_translations: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
data/docs/Branch.md
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**base_project_id** | **String** | | [optional]
|
|
8
|
+
**branch_project_id** | **String** | | [optional]
|
|
7
9
|
**name** | **String** | | [optional]
|
|
8
10
|
**created_at** | **DateTime** | | [optional]
|
|
9
11
|
**updated_at** | **DateTime** | | [optional]
|
|
@@ -17,7 +19,9 @@ Name | Type | Description | Notes
|
|
|
17
19
|
```ruby
|
|
18
20
|
require 'Phrase'
|
|
19
21
|
|
|
20
|
-
instance = Phrase::Branch.new(
|
|
22
|
+
instance = Phrase::Branch.new(base_project_id: null,
|
|
23
|
+
branch_project_id: null,
|
|
24
|
+
name: null,
|
|
21
25
|
created_at: null,
|
|
22
26
|
updated_at: null,
|
|
23
27
|
merged_at: null,
|
data/docs/Comment.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**user** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
10
10
|
**created_at** | **DateTime** | | [optional]
|
|
11
11
|
**updated_at** | **DateTime** | | [optional]
|
|
12
|
+
**mentioned_users** | [**Array<UserPreview>**](UserPreview.md) | | [optional]
|
|
12
13
|
|
|
13
14
|
## Code Sample
|
|
14
15
|
|
|
@@ -19,7 +20,8 @@ instance = Phrase::Comment.new(id: null,
|
|
|
19
20
|
message: null,
|
|
20
21
|
user: null,
|
|
21
22
|
created_at: null,
|
|
22
|
-
updated_at: null
|
|
23
|
+
updated_at: null,
|
|
24
|
+
mentioned_users: null)
|
|
23
25
|
```
|
|
24
26
|
|
|
25
27
|
|
data/docs/JobTemplate.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Phrase::JobTemplate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | | [optional]
|
|
8
|
+
**name** | **String** | | [optional]
|
|
9
|
+
**briefing** | **String** | | [optional]
|
|
10
|
+
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
|
11
|
+
**branch** | [**Branch**](Branch.md) | | [optional]
|
|
12
|
+
**created_at** | **DateTime** | | [optional]
|
|
13
|
+
**updated_at** | **DateTime** | | [optional]
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'Phrase'
|
|
19
|
+
|
|
20
|
+
instance = Phrase::JobTemplate.new(id: null,
|
|
21
|
+
name: null,
|
|
22
|
+
briefing: null,
|
|
23
|
+
project: null,
|
|
24
|
+
branch: null,
|
|
25
|
+
created_at: null,
|
|
26
|
+
updated_at: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Phrase::JobTemplateCreateParameters
|
|
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::JobTemplateCreateParameters.new(branch: my-feature-branch,
|
|
17
|
+
name: template,
|
|
18
|
+
briefing: text)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -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
|
+
|