phrase 2.8.2 → 2.8.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +15 -12
- data/docs/AccountsApi.md +2 -2
- data/docs/AuthorizationsApi.md +2 -2
- data/docs/BitbucketSyncApi.md +2 -2
- data/docs/BlacklistedKeysApi.md +2 -2
- data/docs/BranchesApi.md +5 -5
- data/docs/CommentsApi.md +2 -2
- data/docs/DistributionsApi.md +2 -2
- data/docs/DocumentsApi.md +2 -2
- data/docs/GitHubSyncApi.md +2 -2
- data/docs/GitLabSyncApi.md +4 -4
- data/docs/GlossariesApi.md +2 -2
- data/docs/GlossaryTermsApi.md +2 -2
- data/docs/InvitationsApi.md +2 -2
- data/docs/JobCommentsApi.md +6 -6
- data/docs/JobLocale.md +3 -1
- data/docs/JobLocaleUpdateParameters.md +5 -1
- data/docs/JobLocalesApi.md +2 -2
- data/docs/JobLocalesCreateParameters.md +6 -2
- data/docs/JobTemplateDetails.md +35 -0
- data/docs/JobTemplateDetails1.md +21 -0
- data/docs/JobTemplateLocaleUpdateParameters.md +6 -2
- data/docs/{JobTemplateLocale.md → JobTemplateLocales.md} +6 -4
- data/docs/JobTemplateLocalesApi.md +10 -10
- data/docs/JobTemplateLocalesCreateParameters.md +5 -1
- data/docs/JobTemplatesApi.md +41 -41
- data/docs/JobsApi.md +4 -4
- data/docs/KeysApi.md +4 -4
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/LocaleTeamPreview.md +21 -0
- data/docs/{JobTemplateUserPreview.md → LocaleUserPreview.md} +2 -2
- data/docs/LocalesApi.md +12 -8
- data/docs/MembersApi.md +2 -2
- data/docs/NotificationGroupDetail.md +1 -1
- data/docs/NotificationGroupsApi.md +6 -6
- data/docs/NotificationsApi.md +8 -6
- data/docs/OrdersApi.md +2 -2
- data/docs/Project.md +2 -0
- data/docs/ProjectCreateParameters.md +5 -1
- data/docs/ProjectDetails.md +2 -0
- data/docs/ProjectUpdateParameters.md +5 -1
- data/docs/ProjectsApi.md +2 -2
- data/docs/ReleasesApi.md +2 -2
- data/docs/ScreenshotMarkersApi.md +2 -2
- data/docs/ScreenshotsApi.md +2 -2
- data/docs/SearchApi.md +1 -1
- data/docs/SpacesApi.md +4 -4
- data/docs/StyleGuidesApi.md +2 -2
- data/docs/TagsApi.md +2 -2
- data/docs/TeamsApi.md +2 -2
- data/docs/TranslationsApi.md +31 -27
- data/docs/TranslationsExcludeParameters.md +1 -1
- data/docs/TranslationsIncludeParameters.md +1 -1
- data/docs/TranslationsReviewParameters.md +1 -1
- data/docs/TranslationsSearchParameters.md +1 -1
- data/docs/TranslationsUnverifyParameters.md +1 -1
- data/docs/TranslationsVerifyParameters.md +1 -1
- data/docs/UploadsApi.md +5 -5
- data/docs/VariablesApi.md +2 -2
- data/docs/VersionsHistoryApi.md +2 -2
- data/docs/WebhooksApi.md +2 -2
- data/lib/phrase/api/accounts_api.rb +2 -2
- data/lib/phrase/api/authorizations_api.rb +2 -2
- data/lib/phrase/api/bitbucket_sync_api.rb +4 -4
- data/lib/phrase/api/blacklisted_keys_api.rb +2 -2
- data/lib/phrase/api/branches_api.rb +8 -8
- data/lib/phrase/api/comments_api.rb +2 -2
- data/lib/phrase/api/distributions_api.rb +2 -2
- data/lib/phrase/api/documents_api.rb +2 -2
- data/lib/phrase/api/git_hub_sync_api.rb +4 -4
- data/lib/phrase/api/git_lab_sync_api.rb +6 -6
- data/lib/phrase/api/glossaries_api.rb +2 -2
- data/lib/phrase/api/glossary_terms_api.rb +2 -2
- data/lib/phrase/api/invitations_api.rb +2 -2
- data/lib/phrase/api/job_comments_api.rb +9 -9
- data/lib/phrase/api/job_locales_api.rb +2 -2
- data/lib/phrase/api/job_template_locales_api.rb +14 -14
- data/lib/phrase/api/job_templates_api.rb +72 -72
- data/lib/phrase/api/jobs_api.rb +4 -4
- data/lib/phrase/api/keys_api.rb +4 -4
- data/lib/phrase/api/locales_api.rb +14 -8
- data/lib/phrase/api/members_api.rb +2 -2
- data/lib/phrase/api/notification_groups_api.rb +8 -8
- data/lib/phrase/api/notifications_api.rb +11 -8
- data/lib/phrase/api/orders_api.rb +2 -2
- data/lib/phrase/api/projects_api.rb +2 -2
- data/lib/phrase/api/releases_api.rb +2 -2
- data/lib/phrase/api/screenshot_markers_api.rb +2 -2
- data/lib/phrase/api/screenshots_api.rb +2 -2
- data/lib/phrase/api/search_api.rb +2 -2
- data/lib/phrase/api/spaces_api.rb +4 -4
- data/lib/phrase/api/style_guides_api.rb +2 -2
- data/lib/phrase/api/tags_api.rb +2 -2
- data/lib/phrase/api/teams_api.rb +2 -2
- data/lib/phrase/api/translations_api.rb +28 -22
- data/lib/phrase/api/uploads_api.rb +4 -4
- data/lib/phrase/api/variables_api.rb +2 -2
- data/lib/phrase/api/versions_history_api.rb +2 -2
- data/lib/phrase/api/webhooks_api.rb +2 -2
- data/lib/phrase/models/job_locale.rb +13 -2
- data/lib/phrase/models/job_locale_update_parameters.rb +28 -4
- data/lib/phrase/models/job_locales_create_parameters.rb +33 -4
- data/lib/phrase/models/job_template_details.rb +285 -0
- data/lib/phrase/models/job_template_details1.rb +214 -0
- data/lib/phrase/models/job_template_locale_update_parameters.rb +28 -9
- data/lib/phrase/models/{job_template_locale.rb → job_template_locales.rb} +18 -7
- data/lib/phrase/models/job_template_locales_create_parameters.rb +28 -4
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/locale_team_preview.rb +212 -0
- data/lib/phrase/models/{job_template_user_preview.rb → locale_user_preview.rb} +3 -3
- data/lib/phrase/models/notification_group_detail.rb +1 -1
- data/lib/phrase/models/project.rb +10 -1
- data/lib/phrase/models/project_create_parameters.rb +22 -2
- data/lib/phrase/models/project_details.rb +10 -1
- data/lib/phrase/models/project_update_parameters.rb +22 -2
- data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
- data/lib/phrase/models/translations_include_parameters.rb +1 -1
- data/lib/phrase/models/translations_review_parameters.rb +1 -1
- data/lib/phrase/models/translations_search_parameters.rb +1 -1
- data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
- data/lib/phrase/models/translations_verify_parameters.rb +1 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +5 -2
- data/spec/api/accounts_api_spec.rb +1 -1
- data/spec/api/authorizations_api_spec.rb +1 -1
- data/spec/api/bitbucket_sync_api_spec.rb +2 -2
- data/spec/api/blacklisted_keys_api_spec.rb +1 -1
- data/spec/api/branches_api_spec.rb +4 -4
- data/spec/api/comments_api_spec.rb +1 -1
- data/spec/api/distributions_api_spec.rb +1 -1
- data/spec/api/documents_api_spec.rb +1 -1
- data/spec/api/git_hub_sync_api_spec.rb +2 -2
- data/spec/api/git_lab_sync_api_spec.rb +3 -3
- data/spec/api/glossaries_api_spec.rb +1 -1
- data/spec/api/glossary_terms_api_spec.rb +1 -1
- data/spec/api/invitations_api_spec.rb +1 -1
- data/spec/api/job_comments_api_spec.rb +3 -3
- data/spec/api/job_locales_api_spec.rb +1 -1
- data/spec/api/job_template_locales_api_spec.rb +5 -5
- data/spec/api/job_templates_api_spec.rb +18 -18
- data/spec/api/jobs_api_spec.rb +2 -2
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/locales_api_spec.rb +6 -4
- data/spec/api/members_api_spec.rb +1 -1
- data/spec/api/notification_groups_api_spec.rb +3 -3
- data/spec/api/notifications_api_spec.rb +4 -3
- data/spec/api/orders_api_spec.rb +1 -1
- data/spec/api/projects_api_spec.rb +1 -1
- data/spec/api/releases_api_spec.rb +1 -1
- data/spec/api/screenshot_markers_api_spec.rb +1 -1
- data/spec/api/screenshots_api_spec.rb +1 -1
- data/spec/api/search_api_spec.rb +1 -1
- data/spec/api/spaces_api_spec.rb +2 -2
- data/spec/api/style_guides_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +1 -1
- data/spec/api/teams_api_spec.rb +1 -1
- data/spec/api/translations_api_spec.rb +13 -11
- data/spec/api/uploads_api_spec.rb +2 -2
- data/spec/api/variables_api_spec.rb +1 -1
- data/spec/api/versions_history_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/models/job_locale_spec.rb +6 -0
- data/spec/models/job_locale_update_parameters_spec.rb +12 -0
- data/spec/models/job_locales_create_parameters_spec.rb +12 -0
- data/spec/models/job_template_details1_spec.rb +41 -0
- data/spec/models/job_template_details_spec.rb +83 -0
- data/spec/models/job_template_locale_update_parameters_spec.rb +12 -0
- data/spec/models/job_template_locales_create_parameters_spec.rb +12 -0
- data/spec/models/{job_template_locale_spec.rb → job_template_locales_spec.rb} +12 -6
- data/spec/models/locale_team_preview_spec.rb +41 -0
- data/spec/models/{job_template_user_preview_spec.rb → locale_user_preview_spec.rb} +6 -6
- data/spec/models/project_create_parameters_spec.rb +12 -0
- data/spec/models/project_details_spec.rb +6 -0
- data/spec/models/project_spec.rb +6 -0
- data/spec/models/project_update_parameters_spec.rb +12 -0
- metadata +237 -225
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 47f6c4332b5679e8b3c28c543b8a651a2ad839a8fb706fd63c731a59decce041
|
|
4
|
+
data.tar.gz: 16b7a3335d2f6a2f08bfb702aac3ea2b9d2b5bae3ead4420870afe2c25dd4d99
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d8f666459ddd0eded14e7d6c6f54126c6c969a5fef445dc4878c00b4b35be1216a327e91d556ed3ce3c63d102b8147895b38323b1c3effdd6b228b69fdb4fa87
|
|
7
|
+
data.tar.gz: 7d8bba43e41afe268313e985b044796a03e15a756509ce67661df19d9569df95773b3a75361939ea2d92935c7658b61ba9239fe21f9d29e28536e5e24ed5e4a4
|
data/LICENSE
CHANGED
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.8.
|
|
10
|
+
- Package version: 2.8.7
|
|
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.8.
|
|
59
|
+
gem install ./phrase-2.8.7.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./phrase-2.8.
|
|
62
|
+
(for development, run `gem install --dev ./phrase-2.8.7.gem` to install the development dependencies)
|
|
63
63
|
|
|
64
64
|
## Getting Started
|
|
65
65
|
|
|
@@ -218,9 +218,9 @@ Class | Method | HTTP request | Description
|
|
|
218
218
|
*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
|
|
219
219
|
*Phrase::JobTemplatesApi* | [**job_template_create**](docs/JobTemplatesApi.md#job_template_create) | **POST** /projects/{project_id}/job_templates | Create a job template
|
|
220
220
|
*Phrase::JobTemplatesApi* | [**job_template_delete**](docs/JobTemplatesApi.md#job_template_delete) | **DELETE** /projects/{project_id}/job_templates/{id} | Delete a job template
|
|
221
|
-
*Phrase::JobTemplatesApi* | [**job_template_show**](docs/JobTemplatesApi.md#job_template_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
|
|
222
221
|
*Phrase::JobTemplatesApi* | [**job_template_update**](docs/JobTemplatesApi.md#job_template_update) | **PATCH** /projects/{project_id}/job_templates/{id} | Update a job template
|
|
223
222
|
*Phrase::JobTemplatesApi* | [**job_templates_list**](docs/JobTemplatesApi.md#job_templates_list) | **GET** /projects/{project_id}/job_templates | List job templates
|
|
223
|
+
*Phrase::JobTemplatesApi* | [**job_templates_show**](docs/JobTemplatesApi.md#job_templates_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
|
|
224
224
|
*Phrase::JobsApi* | [**job_complete**](docs/JobsApi.md#job_complete) | **POST** /projects/{project_id}/jobs/{id}/complete | Complete a job
|
|
225
225
|
*Phrase::JobsApi* | [**job_create**](docs/JobsApi.md#job_create) | **POST** /projects/{project_id}/jobs | Create a job
|
|
226
226
|
*Phrase::JobsApi* | [**job_delete**](docs/JobsApi.md#job_delete) | **DELETE** /projects/{project_id}/jobs/{id} | Delete a job
|
|
@@ -320,7 +320,7 @@ Class | Method | HTTP request | Description
|
|
|
320
320
|
*Phrase::TeamsApi* | [**teams_users_delete**](docs/TeamsApi.md#teams_users_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/users/{id} | Remove User
|
|
321
321
|
*Phrase::TranslationsApi* | [**translation_create**](docs/TranslationsApi.md#translation_create) | **POST** /projects/{project_id}/translations | Create a translation
|
|
322
322
|
*Phrase::TranslationsApi* | [**translation_exclude**](docs/TranslationsApi.md#translation_exclude) | **PATCH** /projects/{project_id}/translations/{id}/exclude | Exclude a translation from export
|
|
323
|
-
*Phrase::TranslationsApi* | [**translation_include**](docs/TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include |
|
|
323
|
+
*Phrase::TranslationsApi* | [**translation_include**](docs/TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
|
|
324
324
|
*Phrase::TranslationsApi* | [**translation_review**](docs/TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
|
|
325
325
|
*Phrase::TranslationsApi* | [**translation_show**](docs/TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
|
|
326
326
|
*Phrase::TranslationsApi* | [**translation_unverify**](docs/TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
|
|
@@ -328,15 +328,15 @@ Class | Method | HTTP request | Description
|
|
|
328
328
|
*Phrase::TranslationsApi* | [**translation_verify**](docs/TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
|
|
329
329
|
*Phrase::TranslationsApi* | [**translations_by_key**](docs/TranslationsApi.md#translations_by_key) | **GET** /projects/{project_id}/keys/{key_id}/translations | List translations by key
|
|
330
330
|
*Phrase::TranslationsApi* | [**translations_by_locale**](docs/TranslationsApi.md#translations_by_locale) | **GET** /projects/{project_id}/locales/{locale_id}/translations | List translations by locale
|
|
331
|
-
*Phrase::TranslationsApi* | [**translations_exclude_collection**](docs/TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude |
|
|
332
|
-
*Phrase::TranslationsApi* | [**translations_include_collection**](docs/TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include |
|
|
331
|
+
*Phrase::TranslationsApi* | [**translations_exclude_collection**](docs/TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude | Exclude translations by query
|
|
332
|
+
*Phrase::TranslationsApi* | [**translations_include_collection**](docs/TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include | Include translations by query
|
|
333
333
|
*Phrase::TranslationsApi* | [**translations_list**](docs/TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
|
|
334
334
|
*Phrase::TranslationsApi* | [**translations_review_collection**](docs/TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
|
|
335
335
|
*Phrase::TranslationsApi* | [**translations_search**](docs/TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
|
|
336
|
-
*Phrase::TranslationsApi* | [**translations_unverify_collection**](docs/TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify |
|
|
337
|
-
*Phrase::TranslationsApi* | [**translations_verify_collection**](docs/TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations
|
|
336
|
+
*Phrase::TranslationsApi* | [**translations_unverify_collection**](docs/TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
|
|
337
|
+
*Phrase::TranslationsApi* | [**translations_verify_collection**](docs/TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
|
|
338
338
|
*Phrase::UploadsApi* | [**upload_create**](docs/UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
|
|
339
|
-
*Phrase::UploadsApi* | [**upload_show**](docs/UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} |
|
|
339
|
+
*Phrase::UploadsApi* | [**upload_show**](docs/UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} | Get a single upload
|
|
340
340
|
*Phrase::UploadsApi* | [**uploads_list**](docs/UploadsApi.md#uploads_list) | **GET** /projects/{project_id}/uploads | List uploads
|
|
341
341
|
*Phrase::UsersApi* | [**show_user**](docs/UsersApi.md#show_user) | **GET** /user | Show current User
|
|
342
342
|
*Phrase::VariablesApi* | [**variable_create**](docs/VariablesApi.md#variable_create) | **POST** /projects/{project_id}/variables | Create a variable
|
|
@@ -437,12 +437,13 @@ Class | Method | HTTP request | Description
|
|
|
437
437
|
- [Phrase::JobStartParameters](docs/JobStartParameters.md)
|
|
438
438
|
- [Phrase::JobTemplate](docs/JobTemplate.md)
|
|
439
439
|
- [Phrase::JobTemplateCreateParameters](docs/JobTemplateCreateParameters.md)
|
|
440
|
-
- [Phrase::
|
|
440
|
+
- [Phrase::JobTemplateDetails](docs/JobTemplateDetails.md)
|
|
441
|
+
- [Phrase::JobTemplateDetails1](docs/JobTemplateDetails1.md)
|
|
441
442
|
- [Phrase::JobTemplateLocaleUpdateParameters](docs/JobTemplateLocaleUpdateParameters.md)
|
|
443
|
+
- [Phrase::JobTemplateLocales](docs/JobTemplateLocales.md)
|
|
442
444
|
- [Phrase::JobTemplateLocalesCreateParameters](docs/JobTemplateLocalesCreateParameters.md)
|
|
443
445
|
- [Phrase::JobTemplatePreview](docs/JobTemplatePreview.md)
|
|
444
446
|
- [Phrase::JobTemplateUpdateParameters](docs/JobTemplateUpdateParameters.md)
|
|
445
|
-
- [Phrase::JobTemplateUserPreview](docs/JobTemplateUserPreview.md)
|
|
446
447
|
- [Phrase::JobUpdateParameters](docs/JobUpdateParameters.md)
|
|
447
448
|
- [Phrase::KeyCreateParameters](docs/KeyCreateParameters.md)
|
|
448
449
|
- [Phrase::KeyPreview](docs/KeyPreview.md)
|
|
@@ -459,7 +460,9 @@ Class | Method | HTTP request | Description
|
|
|
459
460
|
- [Phrase::LocalePreview](docs/LocalePreview.md)
|
|
460
461
|
- [Phrase::LocalePreview1](docs/LocalePreview1.md)
|
|
461
462
|
- [Phrase::LocaleStatistics](docs/LocaleStatistics.md)
|
|
463
|
+
- [Phrase::LocaleTeamPreview](docs/LocaleTeamPreview.md)
|
|
462
464
|
- [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
|
|
465
|
+
- [Phrase::LocaleUserPreview](docs/LocaleUserPreview.md)
|
|
463
466
|
- [Phrase::Member](docs/Member.md)
|
|
464
467
|
- [Phrase::MemberProjectDetail](docs/MemberProjectDetail.md)
|
|
465
468
|
- [Phrase::MemberProjectDetailProjectRoles](docs/MemberProjectDetailProjectRoles.md)
|
data/docs/AccountsApi.md
CHANGED
|
@@ -98,7 +98,7 @@ api_instance = Phrase::AccountsApi.new
|
|
|
98
98
|
opts = {
|
|
99
99
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
100
100
|
page: 1, # Integer | Page number
|
|
101
|
-
per_page: 25 # Integer |
|
|
101
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
102
102
|
}
|
|
103
103
|
|
|
104
104
|
begin
|
|
@@ -117,7 +117,7 @@ Name | Type | Description | Notes
|
|
|
117
117
|
------------- | ------------- | ------------- | -------------
|
|
118
118
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
119
119
|
**page** | **Integer**| Page number | [optional]
|
|
120
|
-
**per_page** | **Integer**|
|
|
120
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
121
121
|
|
|
122
122
|
### Return type
|
|
123
123
|
|
data/docs/AuthorizationsApi.md
CHANGED
|
@@ -285,7 +285,7 @@ api_instance = Phrase::AuthorizationsApi.new
|
|
|
285
285
|
opts = {
|
|
286
286
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
287
287
|
page: 1, # Integer | Page number
|
|
288
|
-
per_page: 25 # Integer |
|
|
288
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
289
289
|
}
|
|
290
290
|
|
|
291
291
|
begin
|
|
@@ -304,7 +304,7 @@ Name | Type | Description | Notes
|
|
|
304
304
|
------------- | ------------- | ------------- | -------------
|
|
305
305
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
306
306
|
**page** | **Integer**| Page number | [optional]
|
|
307
|
-
**per_page** | **Integer**|
|
|
307
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
308
308
|
|
|
309
309
|
### Return type
|
|
310
310
|
|
data/docs/BitbucketSyncApi.md
CHANGED
|
@@ -16,7 +16,7 @@ Method | HTTP request | Description
|
|
|
16
16
|
|
|
17
17
|
Export from Phrase Strings to Bitbucket
|
|
18
18
|
|
|
19
|
-
Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.
|
|
19
|
+
Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository. <br><br><i>Note: Export is done asynchronously and may take several seconds depending on the project size.</i>
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -79,7 +79,7 @@ Response<([**BitbucketSyncExportResponse**](BitbucketSyncExportResponse.md))>
|
|
|
79
79
|
|
|
80
80
|
Import to Phrase Strings from Bitbucket
|
|
81
81
|
|
|
82
|
-
Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository.
|
|
82
|
+
Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository. <br><br><i>Note: Import is done asynchronously and may take several seconds depending on the project size.</i>
|
|
83
83
|
|
|
84
84
|
### Example
|
|
85
85
|
|
data/docs/BlacklistedKeysApi.md
CHANGED
|
@@ -294,7 +294,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
294
294
|
opts = {
|
|
295
295
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
296
296
|
page: 1, # Integer | Page number
|
|
297
|
-
per_page: 25, # Integer |
|
|
297
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
298
298
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
299
299
|
}
|
|
300
300
|
|
|
@@ -315,7 +315,7 @@ Name | Type | Description | Notes
|
|
|
315
315
|
**project_id** | **String**| Project ID |
|
|
316
316
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
317
317
|
**page** | **Integer**| Page number | [optional]
|
|
318
|
-
**per_page** | **Integer**|
|
|
318
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
319
319
|
**branch** | **String**| specify the branch to use | [optional]
|
|
320
320
|
|
|
321
321
|
### Return type
|
data/docs/BranchesApi.md
CHANGED
|
@@ -20,7 +20,7 @@ Method | HTTP request | Description
|
|
|
20
20
|
|
|
21
21
|
Compare branches
|
|
22
22
|
|
|
23
|
-
Compare branch with main branch.
|
|
23
|
+
Compare branch with main branch. <br><br><i>Note: Comparing a branch may take several minutes depending on the project size.</i>
|
|
24
24
|
|
|
25
25
|
### Example
|
|
26
26
|
|
|
@@ -82,7 +82,7 @@ Response<(nil (empty response body))>
|
|
|
82
82
|
|
|
83
83
|
Create a branch
|
|
84
84
|
|
|
85
|
-
Create a new branch.
|
|
85
|
+
Create a new branch. <br><br><i>Note: Creating a new branch may take several minutes depending on the project size.</i>
|
|
86
86
|
|
|
87
87
|
### Example
|
|
88
88
|
|
|
@@ -207,7 +207,7 @@ Response<(nil (empty response body))>
|
|
|
207
207
|
|
|
208
208
|
Merge a branch
|
|
209
209
|
|
|
210
|
-
Merge an existing branch.
|
|
210
|
+
Merge an existing branch. <br><br><i>Note: Merging a branch may take several minutes depending on diff size.</i>
|
|
211
211
|
|
|
212
212
|
### Example
|
|
213
213
|
|
|
@@ -422,7 +422,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
422
422
|
opts = {
|
|
423
423
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
424
424
|
page: 1, # Integer | Page number
|
|
425
|
-
per_page: 25 # Integer |
|
|
425
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
426
426
|
}
|
|
427
427
|
|
|
428
428
|
begin
|
|
@@ -442,7 +442,7 @@ Name | Type | Description | Notes
|
|
|
442
442
|
**project_id** | **String**| Project ID |
|
|
443
443
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
444
444
|
**page** | **Integer**| Page number | [optional]
|
|
445
|
-
**per_page** | **Integer**|
|
|
445
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
446
446
|
|
|
447
447
|
### Return type
|
|
448
448
|
|
data/docs/CommentsApi.md
CHANGED
|
@@ -508,7 +508,7 @@ key_id = 'key_id_example' # String | Translation Key ID
|
|
|
508
508
|
opts = {
|
|
509
509
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
510
510
|
page: 1, # Integer | Page number
|
|
511
|
-
per_page: 25, # Integer |
|
|
511
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
512
512
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
513
513
|
}
|
|
514
514
|
|
|
@@ -530,7 +530,7 @@ Name | Type | Description | Notes
|
|
|
530
530
|
**key_id** | **String**| Translation Key ID |
|
|
531
531
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
532
532
|
**page** | **Integer**| Page number | [optional]
|
|
533
|
-
**per_page** | **Integer**|
|
|
533
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
534
534
|
**branch** | **String**| specify the branch to use | [optional]
|
|
535
535
|
|
|
536
536
|
### Return type
|
data/docs/DistributionsApi.md
CHANGED
|
@@ -294,7 +294,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
|
294
294
|
opts = {
|
|
295
295
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
296
296
|
page: 1, # Integer | Page number
|
|
297
|
-
per_page: 25 # Integer |
|
|
297
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
298
298
|
}
|
|
299
299
|
|
|
300
300
|
begin
|
|
@@ -314,7 +314,7 @@ Name | Type | Description | Notes
|
|
|
314
314
|
**account_id** | **String**| Account ID |
|
|
315
315
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
316
316
|
**page** | **Integer**| Page number | [optional]
|
|
317
|
-
**per_page** | **Integer**|
|
|
317
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
318
318
|
|
|
319
319
|
### Return type
|
|
320
320
|
|
data/docs/DocumentsApi.md
CHANGED
|
@@ -100,7 +100,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
100
100
|
opts = {
|
|
101
101
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
102
102
|
page: 1, # Integer | Page number
|
|
103
|
-
per_page: 25 # Integer |
|
|
103
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
104
104
|
}
|
|
105
105
|
|
|
106
106
|
begin
|
|
@@ -120,7 +120,7 @@ Name | Type | Description | Notes
|
|
|
120
120
|
**project_id** | **String**| Project ID |
|
|
121
121
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
122
122
|
**page** | **Integer**| Page number | [optional]
|
|
123
|
-
**per_page** | **Integer**|
|
|
123
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
124
124
|
|
|
125
125
|
### Return type
|
|
126
126
|
|
data/docs/GitHubSyncApi.md
CHANGED
|
@@ -15,7 +15,7 @@ Method | HTTP request | Description
|
|
|
15
15
|
|
|
16
16
|
Export from Phrase Strings to GitHub
|
|
17
17
|
|
|
18
|
-
Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub repository.
|
|
18
|
+
Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub repository. <br><br><i>Note: Export is done asynchronously and may take several seconds depending on the project size.</i>
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
|
|
@@ -75,7 +75,7 @@ Response<(nil (empty response body))>
|
|
|
75
75
|
|
|
76
76
|
Import to Phrase Strings from GitHub
|
|
77
77
|
|
|
78
|
-
Import files to Phrase Strings from your connected GitHub repository.
|
|
78
|
+
Import files to Phrase Strings from your connected GitHub repository. <br><br><i>Note: Import is done asynchronously and may take several seconds depending on the project size.</i>
|
|
79
79
|
|
|
80
80
|
### Example
|
|
81
81
|
|
data/docs/GitLabSyncApi.md
CHANGED
|
@@ -82,7 +82,7 @@ Response<(nil (empty response body))>
|
|
|
82
82
|
|
|
83
83
|
Export from Phrase Strings to GitLab
|
|
84
84
|
|
|
85
|
-
Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository.
|
|
85
|
+
Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository. <br><br><i>Note: Export is done asynchronously and may take several seconds depending on the project size.</i>
|
|
86
86
|
|
|
87
87
|
### Example
|
|
88
88
|
|
|
@@ -168,7 +168,7 @@ gitlab_sync_id = 'gitlab_sync_id_example' # String | Gitlab Sync ID
|
|
|
168
168
|
opts = {
|
|
169
169
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
170
170
|
page: 1, # Integer | Page number
|
|
171
|
-
per_page: 25, # Integer |
|
|
171
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
172
172
|
account_id: 'abcd1234' # String | Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
|
|
173
173
|
}
|
|
174
174
|
|
|
@@ -189,7 +189,7 @@ Name | Type | Description | Notes
|
|
|
189
189
|
**gitlab_sync_id** | **String**| Gitlab Sync ID |
|
|
190
190
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
191
191
|
**page** | **Integer**| Page number | [optional]
|
|
192
|
-
**per_page** | **Integer**|
|
|
192
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
193
193
|
**account_id** | **String**| Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
194
194
|
|
|
195
195
|
### Return type
|
|
@@ -212,7 +212,7 @@ Response<([**Array<GitlabSyncHistory>**](GitlabSyncHistory.md))>
|
|
|
212
212
|
|
|
213
213
|
Import from GitLab to Phrase
|
|
214
214
|
|
|
215
|
-
Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository.
|
|
215
|
+
Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository. <br><br><i>Note: Import is done asynchronously and may take several seconds depending on the project size.</i>
|
|
216
216
|
|
|
217
217
|
### Example
|
|
218
218
|
|
data/docs/GlossariesApi.md
CHANGED
|
@@ -41,7 +41,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
|
41
41
|
opts = {
|
|
42
42
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
43
43
|
page: 1, # Integer | Page number
|
|
44
|
-
per_page: 25 # Integer |
|
|
44
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
45
45
|
}
|
|
46
46
|
|
|
47
47
|
begin
|
|
@@ -61,7 +61,7 @@ Name | Type | Description | Notes
|
|
|
61
61
|
**account_id** | **String**| Account ID |
|
|
62
62
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
63
63
|
**page** | **Integer**| Page number | [optional]
|
|
64
|
-
**per_page** | **Integer**|
|
|
64
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
65
65
|
|
|
66
66
|
### Return type
|
|
67
67
|
|
data/docs/GlossaryTermsApi.md
CHANGED
|
@@ -303,7 +303,7 @@ glossary_id = 'glossary_id_example' # String | Glossary ID
|
|
|
303
303
|
opts = {
|
|
304
304
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
305
305
|
page: 1, # Integer | Page number
|
|
306
|
-
per_page: 25 # Integer |
|
|
306
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
307
307
|
}
|
|
308
308
|
|
|
309
309
|
begin
|
|
@@ -324,7 +324,7 @@ Name | Type | Description | Notes
|
|
|
324
324
|
**glossary_id** | **String**| Glossary ID |
|
|
325
325
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
326
326
|
**page** | **Integer**| Page number | [optional]
|
|
327
|
-
**per_page** | **Integer**|
|
|
327
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
328
328
|
|
|
329
329
|
### Return type
|
|
330
330
|
|
data/docs/InvitationsApi.md
CHANGED
|
@@ -424,7 +424,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
|
424
424
|
opts = {
|
|
425
425
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
426
426
|
page: 1, # Integer | Page number
|
|
427
|
-
per_page: 25 # Integer |
|
|
427
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
428
428
|
}
|
|
429
429
|
|
|
430
430
|
begin
|
|
@@ -444,7 +444,7 @@ Name | Type | Description | Notes
|
|
|
444
444
|
**account_id** | **String**| Account ID |
|
|
445
445
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
446
446
|
**page** | **Integer**| Page number | [optional]
|
|
447
|
-
**per_page** | **Integer**|
|
|
447
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
448
448
|
|
|
449
449
|
### Return type
|
|
450
450
|
|
data/docs/JobCommentsApi.md
CHANGED
|
@@ -145,7 +145,7 @@ Response<(nil (empty response body))>
|
|
|
145
145
|
|
|
146
146
|
## job_comment_show
|
|
147
147
|
|
|
148
|
-
>
|
|
148
|
+
> JobComment job_comment_show(project_id, job_id, id, opts)
|
|
149
149
|
|
|
150
150
|
Get a single job comment
|
|
151
151
|
|
|
@@ -198,7 +198,7 @@ Name | Type | Description | Notes
|
|
|
198
198
|
|
|
199
199
|
### Return type
|
|
200
200
|
|
|
201
|
-
Response<(**
|
|
201
|
+
Response<([**JobComment**](JobComment.md))>
|
|
202
202
|
|
|
203
203
|
### Authorization
|
|
204
204
|
|
|
@@ -212,7 +212,7 @@ Response<(**Object**)>
|
|
|
212
212
|
|
|
213
213
|
## job_comment_update
|
|
214
214
|
|
|
215
|
-
>
|
|
215
|
+
> JobComment job_comment_update(project_id, key_id, id, job_comment_update_parameters, opts)
|
|
216
216
|
|
|
217
217
|
Update a job comment
|
|
218
218
|
|
|
@@ -265,7 +265,7 @@ Name | Type | Description | Notes
|
|
|
265
265
|
|
|
266
266
|
### Return type
|
|
267
267
|
|
|
268
|
-
Response<(**
|
|
268
|
+
Response<([**JobComment**](JobComment.md))>
|
|
269
269
|
|
|
270
270
|
### Authorization
|
|
271
271
|
|
|
@@ -279,7 +279,7 @@ Response<(**Object**)>
|
|
|
279
279
|
|
|
280
280
|
## job_comments_list
|
|
281
281
|
|
|
282
|
-
> Array<
|
|
282
|
+
> Array<JobComment> job_comments_list(project_id, job_id, opts)
|
|
283
283
|
|
|
284
284
|
List job comments
|
|
285
285
|
|
|
@@ -330,7 +330,7 @@ Name | Type | Description | Notes
|
|
|
330
330
|
|
|
331
331
|
### Return type
|
|
332
332
|
|
|
333
|
-
Response<(**Array<
|
|
333
|
+
Response<([**Array<JobComment>**](JobComment.md))>
|
|
334
334
|
|
|
335
335
|
### Authorization
|
|
336
336
|
|
data/docs/JobLocale.md
CHANGED
|
@@ -7,7 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**id** | **String** | | [optional]
|
|
8
8
|
**job** | [**JobPreview**](JobPreview.md) | | [optional]
|
|
9
9
|
**locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
10
|
-
**users** | [**Array<
|
|
10
|
+
**users** | [**Array<LocaleUserPreview>**](LocaleUserPreview.md) | | [optional]
|
|
11
|
+
**teams** | [**Array<LocaleTeamPreview>**](LocaleTeamPreview.md) | | [optional]
|
|
11
12
|
**completed** | **Boolean** | | [optional]
|
|
12
13
|
**translation_completed_at** | **DateTime** | | [optional]
|
|
13
14
|
**review_completed_at** | **DateTime** | | [optional]
|
|
@@ -21,6 +22,7 @@ instance = Phrase::JobLocale.new(id: null,
|
|
|
21
22
|
job: null,
|
|
22
23
|
locale: null,
|
|
23
24
|
users: null,
|
|
25
|
+
teams: null,
|
|
24
26
|
completed: null,
|
|
25
27
|
translation_completed_at: null,
|
|
26
28
|
review_completed_at: null)
|
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**locale_id** | **String** | locale id | [optional]
|
|
9
9
|
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job locale | [optional]
|
|
10
10
|
**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job locale as reviewers | [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]
|
|
11
13
|
|
|
12
14
|
## Code Sample
|
|
13
15
|
|
|
@@ -17,7 +19,9 @@ require 'Phrase'
|
|
|
17
19
|
instance = Phrase::JobLocaleUpdateParameters.new(branch: my-feature-branch,
|
|
18
20
|
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
|
19
21
|
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
20
|
-
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"]
|
|
22
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
23
|
+
translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
24
|
+
reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
|
21
25
|
```
|
|
22
26
|
|
|
23
27
|
|
data/docs/JobLocalesApi.md
CHANGED
|
@@ -511,7 +511,7 @@ job_id = 'job_id_example' # String | Job ID
|
|
|
511
511
|
opts = {
|
|
512
512
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
513
513
|
page: 1, # Integer | Page number
|
|
514
|
-
per_page: 25, # Integer |
|
|
514
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
515
515
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
516
516
|
}
|
|
517
517
|
|
|
@@ -533,7 +533,7 @@ Name | Type | Description | Notes
|
|
|
533
533
|
**job_id** | **String**| Job ID |
|
|
534
534
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
535
535
|
**page** | **Integer**| Page number | [optional]
|
|
536
|
-
**per_page** | **Integer**|
|
|
536
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
537
537
|
**branch** | **String**| specify the branch to use | [optional]
|
|
538
538
|
|
|
539
539
|
### Return type
|
|
@@ -5,9 +5,11 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**locale_id** | **String** | locale id |
|
|
8
|
+
**locale_id** | **String** | locale id |
|
|
9
9
|
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job locale as translators | [optional]
|
|
10
10
|
**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job locale as reviewers | [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]
|
|
11
13
|
|
|
12
14
|
## Code Sample
|
|
13
15
|
|
|
@@ -17,7 +19,9 @@ require 'Phrase'
|
|
|
17
19
|
instance = Phrase::JobLocalesCreateParameters.new(branch: my-feature-branch,
|
|
18
20
|
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
|
19
21
|
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
20
|
-
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"]
|
|
22
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
23
|
+
translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
24
|
+
reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
|
21
25
|
```
|
|
22
26
|
|
|
23
27
|
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Phrase::JobTemplateDetails
|
|
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
|
+
**owner** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
15
|
+
**creator** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
16
|
+
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
|
17
|
+
|
|
18
|
+
## Code Sample
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'Phrase'
|
|
22
|
+
|
|
23
|
+
instance = Phrase::JobTemplateDetails.new(id: null,
|
|
24
|
+
name: null,
|
|
25
|
+
briefing: null,
|
|
26
|
+
project: null,
|
|
27
|
+
branch: null,
|
|
28
|
+
created_at: null,
|
|
29
|
+
updated_at: null,
|
|
30
|
+
owner: null,
|
|
31
|
+
creator: null,
|
|
32
|
+
locales: null)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Phrase::JobTemplateDetails1
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**owner** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
8
|
+
**creator** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
9
|
+
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'Phrase'
|
|
15
|
+
|
|
16
|
+
instance = Phrase::JobTemplateDetails1.new(owner: null,
|
|
17
|
+
creator: null,
|
|
18
|
+
locales: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -5,9 +5,11 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**locale_id** | **String** | locale id |
|
|
8
|
+
**locale_id** | **String** | locale id | [optional]
|
|
9
9
|
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job template locale | [optional]
|
|
10
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]
|
|
11
13
|
|
|
12
14
|
## Code Sample
|
|
13
15
|
|
|
@@ -17,7 +19,9 @@ require 'Phrase'
|
|
|
17
19
|
instance = Phrase::JobTemplateLocaleUpdateParameters.new(branch: my-feature-branch,
|
|
18
20
|
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
|
19
21
|
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
20
|
-
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"]
|
|
22
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
23
|
+
translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
24
|
+
reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
|
21
25
|
```
|
|
22
26
|
|
|
23
27
|
|