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
data/docs/NotificationsApi.md
CHANGED
|
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
|
12
12
|
|
|
13
13
|
## notifications_list
|
|
14
14
|
|
|
15
|
-
> Array<
|
|
15
|
+
> Array<Notification> notifications_list(opts)
|
|
16
16
|
|
|
17
17
|
List notifications
|
|
18
18
|
|
|
@@ -38,7 +38,8 @@ api_instance = Phrase::NotificationsApi.new
|
|
|
38
38
|
opts = {
|
|
39
39
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
40
40
|
page: 1, # Integer | Page number
|
|
41
|
-
per_page: 25 # Integer |
|
|
41
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
42
|
+
unseen: true # Boolean | Include only unseen notifications
|
|
42
43
|
}
|
|
43
44
|
|
|
44
45
|
begin
|
|
@@ -57,11 +58,12 @@ Name | Type | Description | Notes
|
|
|
57
58
|
------------- | ------------- | ------------- | -------------
|
|
58
59
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
59
60
|
**page** | **Integer**| Page number | [optional]
|
|
60
|
-
**per_page** | **Integer**|
|
|
61
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
62
|
+
**unseen** | **Boolean**| Include only unseen notifications | [optional]
|
|
61
63
|
|
|
62
64
|
### Return type
|
|
63
65
|
|
|
64
|
-
Response<(**Array<
|
|
66
|
+
Response<([**Array<Notification>**](Notification.md))>
|
|
65
67
|
|
|
66
68
|
### Authorization
|
|
67
69
|
|
|
@@ -75,7 +77,7 @@ Response<(**Array<Object>**)>
|
|
|
75
77
|
|
|
76
78
|
## notifications_mark_all_as_read
|
|
77
79
|
|
|
78
|
-
> Array<
|
|
80
|
+
> Array<Notification> notifications_mark_all_as_read(opts)
|
|
79
81
|
|
|
80
82
|
Mark all notifications as read
|
|
81
83
|
|
|
@@ -120,7 +122,7 @@ Name | Type | Description | Notes
|
|
|
120
122
|
|
|
121
123
|
### Return type
|
|
122
124
|
|
|
123
|
-
Response<(**Array<
|
|
125
|
+
Response<([**Array<Notification>**](Notification.md))>
|
|
124
126
|
|
|
125
127
|
### Authorization
|
|
126
128
|
|
data/docs/OrdersApi.md
CHANGED
|
@@ -298,7 +298,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
298
298
|
opts = {
|
|
299
299
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
300
300
|
page: 1, # Integer | Page number
|
|
301
|
-
per_page: 25, # Integer |
|
|
301
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
302
302
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
303
303
|
}
|
|
304
304
|
|
|
@@ -319,7 +319,7 @@ Name | Type | Description | Notes
|
|
|
319
319
|
**project_id** | **String**| Project ID |
|
|
320
320
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
321
321
|
**page** | **Integer**| Page number | [optional]
|
|
322
|
-
**per_page** | **Integer**|
|
|
322
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
323
323
|
**branch** | **String**| specify the branch to use | [optional]
|
|
324
324
|
|
|
325
325
|
### Return type
|
data/docs/Project.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**slug** | **String** | | [optional]
|
|
10
10
|
**main_format** | **String** | | [optional]
|
|
11
11
|
**project_image_url** | **String** | | [optional]
|
|
12
|
+
**media** | **String** | | [optional]
|
|
12
13
|
**account** | [**Account**](Account.md) | | [optional]
|
|
13
14
|
**space** | [**Space1**](Space1.md) | | [optional]
|
|
14
15
|
**point_of_contact** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
@@ -25,6 +26,7 @@ instance = Phrase::Project.new(id: null,
|
|
|
25
26
|
slug: null,
|
|
26
27
|
main_format: null,
|
|
27
28
|
project_image_url: null,
|
|
29
|
+
media: null,
|
|
28
30
|
account: null,
|
|
29
31
|
space: null,
|
|
30
32
|
point_of_contact: null,
|
|
@@ -5,11 +5,13 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Name of the project | [optional]
|
|
8
|
-
**main_format** | **String** | Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://support.phrase.com/hc/en-us/
|
|
8
|
+
**main_format** | **String** | Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional]
|
|
9
|
+
**media** | **String** | (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`, `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value. | [optional]
|
|
9
10
|
**shares_translation_memory** | **Boolean** | Indicates whether the project should share the account's translation memory | [optional]
|
|
10
11
|
**project_image** | **File** | Image to identify the project | [optional]
|
|
11
12
|
**remove_project_image** | **Boolean** | Indicates whether the project image should be deleted. | [optional]
|
|
12
13
|
**account_id** | **String** | Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
14
|
+
**point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. | [optional]
|
|
13
15
|
**source_project_id** | **String** | When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params. | [optional]
|
|
14
16
|
**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\". <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\">Read more</a> | [optional]
|
|
15
17
|
**machine_translation_enabled** | **Boolean** | (Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest | [optional]
|
|
@@ -36,10 +38,12 @@ require 'Phrase'
|
|
|
36
38
|
|
|
37
39
|
instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
|
|
38
40
|
main_format: yml,
|
|
41
|
+
media: Python,
|
|
39
42
|
shares_translation_memory: true,
|
|
40
43
|
project_image: null,
|
|
41
44
|
remove_project_image: null,
|
|
42
45
|
account_id: abcd1234,
|
|
46
|
+
point_of_contact: abcd1234,
|
|
43
47
|
source_project_id: abcd1234,
|
|
44
48
|
workflow: review,
|
|
45
49
|
machine_translation_enabled: true,
|
data/docs/ProjectDetails.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**slug** | **String** | | [optional]
|
|
10
10
|
**main_format** | **String** | | [optional]
|
|
11
11
|
**project_image_url** | **String** | | [optional]
|
|
12
|
+
**media** | **String** | | [optional]
|
|
12
13
|
**account** | [**Account**](Account.md) | | [optional]
|
|
13
14
|
**space** | [**Space1**](Space1.md) | | [optional]
|
|
14
15
|
**point_of_contact** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
@@ -26,6 +27,7 @@ instance = Phrase::ProjectDetails.new(id: null,
|
|
|
26
27
|
slug: null,
|
|
27
28
|
main_format: null,
|
|
28
29
|
project_image_url: null,
|
|
30
|
+
media: null,
|
|
29
31
|
account: null,
|
|
30
32
|
space: null,
|
|
31
33
|
point_of_contact: null,
|
|
@@ -6,7 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**account_id** | **String** | Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in. | [optional]
|
|
8
8
|
**name** | **String** | (Optional) Name of the project | [optional]
|
|
9
|
-
**
|
|
9
|
+
**point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. Pass `null` to unset. | [optional]
|
|
10
|
+
**main_format** | **String** | (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional]
|
|
11
|
+
**media** | **String** | (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`, `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value. | [optional]
|
|
10
12
|
**shares_translation_memory** | **Boolean** | (Optional) Indicates whether the project should share the account's translation memory | [optional]
|
|
11
13
|
**project_image** | **File** | (Optional) Image to identify the project | [optional]
|
|
12
14
|
**remove_project_image** | **Boolean** | (Optional) Indicates whether the project image should be deleted. | [optional]
|
|
@@ -35,7 +37,9 @@ require 'Phrase'
|
|
|
35
37
|
|
|
36
38
|
instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
|
|
37
39
|
name: My Android Project,
|
|
40
|
+
point_of_contact: abcd1234,
|
|
38
41
|
main_format: yml,
|
|
42
|
+
media: Python,
|
|
39
43
|
shares_translation_memory: true,
|
|
40
44
|
project_image: null,
|
|
41
45
|
remove_project_image: false,
|
data/docs/ProjectsApi.md
CHANGED
|
@@ -285,7 +285,7 @@ api_instance = Phrase::ProjectsApi.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
|
account_id: 'account_id_example', # String | Filter by Account ID
|
|
290
290
|
sort_by: 'sort_by_example', # String | Sort projects. Valid options are \"name_asc\", \"name_desc\", \"updated_at_asc\", \"updated_at_desc\", \"space_asc\" and \"space_desc\".
|
|
291
291
|
filters: ['favorites'] # Array<String> | Filter projects. Valid options are [\"favorites\"].
|
|
@@ -307,7 +307,7 @@ Name | Type | Description | Notes
|
|
|
307
307
|
------------- | ------------- | ------------- | -------------
|
|
308
308
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
309
309
|
**page** | **Integer**| Page number | [optional]
|
|
310
|
-
**per_page** | **Integer**|
|
|
310
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
311
311
|
**account_id** | **String**| Filter by Account ID | [optional]
|
|
312
312
|
**sort_by** | **String**| Sort projects. Valid options are \"name_asc\", \"name_desc\", \"updated_at_asc\", \"updated_at_desc\", \"space_asc\" and \"space_desc\". | [optional]
|
|
313
313
|
**filters** | [**Array<String>**](String.md)| Filter projects. Valid options are [\"favorites\"]. | [optional]
|
data/docs/ReleasesApi.md
CHANGED
|
@@ -369,7 +369,7 @@ distribution_id = 'distribution_id_example' # String | Distribution ID
|
|
|
369
369
|
opts = {
|
|
370
370
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
371
371
|
page: 1, # Integer | Page number
|
|
372
|
-
per_page: 25 # Integer |
|
|
372
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
373
373
|
}
|
|
374
374
|
|
|
375
375
|
begin
|
|
@@ -390,7 +390,7 @@ Name | Type | Description | Notes
|
|
|
390
390
|
**distribution_id** | **String**| Distribution ID |
|
|
391
391
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
392
392
|
**page** | **Integer**| Page number | [optional]
|
|
393
|
-
**per_page** | **Integer**|
|
|
393
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
394
394
|
|
|
395
395
|
### Return type
|
|
396
396
|
|
|
@@ -303,7 +303,7 @@ id = 'id_example' # String | 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
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
308
308
|
}
|
|
309
309
|
|
|
@@ -325,7 +325,7 @@ Name | Type | Description | Notes
|
|
|
325
325
|
**id** | **String**| ID |
|
|
326
326
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
327
327
|
**page** | **Integer**| Page number | [optional]
|
|
328
|
-
**per_page** | **Integer**|
|
|
328
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
329
329
|
**branch** | **String**| specify the branch to use | [optional]
|
|
330
330
|
|
|
331
331
|
### Return type
|
data/docs/ScreenshotsApi.md
CHANGED
|
@@ -304,7 +304,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
304
304
|
opts = {
|
|
305
305
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
306
306
|
page: 1, # Integer | Page number
|
|
307
|
-
per_page: 25, # Integer |
|
|
307
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
308
308
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
309
309
|
key_id: 'abcd1234cdef1234abcd1234cdef1234' # String | filter by key
|
|
310
310
|
}
|
|
@@ -326,7 +326,7 @@ Name | Type | Description | Notes
|
|
|
326
326
|
**project_id** | **String**| Project ID |
|
|
327
327
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
328
328
|
**page** | **Integer**| Page number | [optional]
|
|
329
|
-
**per_page** | **Integer**|
|
|
329
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
330
330
|
**branch** | **String**| specify the branch to use | [optional]
|
|
331
331
|
**key_id** | **String**| filter by key | [optional]
|
|
332
332
|
|
data/docs/SearchApi.md
CHANGED
|
@@ -14,7 +14,7 @@ Method | HTTP request | Description
|
|
|
14
14
|
|
|
15
15
|
Search across projects
|
|
16
16
|
|
|
17
|
-
Search for keys and translations in all account projects
|
|
17
|
+
Search for keys and translations in all account projects <br><br><i>Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.</i>
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
data/docs/SpacesApi.md
CHANGED
|
@@ -297,7 +297,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
|
297
297
|
opts = {
|
|
298
298
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
299
299
|
page: 1, # Integer | Page number
|
|
300
|
-
per_page: 25 # Integer |
|
|
300
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
301
301
|
}
|
|
302
302
|
|
|
303
303
|
begin
|
|
@@ -317,7 +317,7 @@ Name | Type | Description | Notes
|
|
|
317
317
|
**account_id** | **String**| Account ID |
|
|
318
318
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
319
319
|
**page** | **Integer**| Page number | [optional]
|
|
320
|
-
**per_page** | **Integer**|
|
|
320
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
321
321
|
|
|
322
322
|
### Return type
|
|
323
323
|
|
|
@@ -491,7 +491,7 @@ space_id = 'space_id_example' # String | Space ID
|
|
|
491
491
|
opts = {
|
|
492
492
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
493
493
|
page: 1, # Integer | Page number
|
|
494
|
-
per_page: 25 # Integer |
|
|
494
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
495
495
|
}
|
|
496
496
|
|
|
497
497
|
begin
|
|
@@ -512,7 +512,7 @@ Name | Type | Description | Notes
|
|
|
512
512
|
**space_id** | **String**| Space ID |
|
|
513
513
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
514
514
|
**page** | **Integer**| Page number | [optional]
|
|
515
|
-
**per_page** | **Integer**|
|
|
515
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
516
516
|
|
|
517
517
|
### Return type
|
|
518
518
|
|
data/docs/StyleGuidesApi.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
|
}
|
|
299
299
|
|
|
300
300
|
begin
|
|
@@ -314,7 +314,7 @@ Name | Type | Description | Notes
|
|
|
314
314
|
**project_id** | **String**| Project 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/TagsApi.md
CHANGED
|
@@ -232,7 +232,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
232
232
|
opts = {
|
|
233
233
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
234
234
|
page: 1, # Integer | Page number
|
|
235
|
-
per_page: 25, # Integer |
|
|
235
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
236
236
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
237
237
|
}
|
|
238
238
|
|
|
@@ -253,7 +253,7 @@ Name | Type | Description | Notes
|
|
|
253
253
|
**project_id** | **String**| Project ID |
|
|
254
254
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
255
255
|
**page** | **Integer**| Page number | [optional]
|
|
256
|
-
**per_page** | **Integer**|
|
|
256
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
257
257
|
**branch** | **String**| specify the branch to use | [optional]
|
|
258
258
|
|
|
259
259
|
### Return type
|
data/docs/TeamsApi.md
CHANGED
|
@@ -300,7 +300,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
|
300
300
|
opts = {
|
|
301
301
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
302
302
|
page: 1, # Integer | Page number
|
|
303
|
-
per_page: 25 # Integer |
|
|
303
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
304
304
|
}
|
|
305
305
|
|
|
306
306
|
begin
|
|
@@ -320,7 +320,7 @@ Name | Type | Description | Notes
|
|
|
320
320
|
**account_id** | **String**| Account ID |
|
|
321
321
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
322
322
|
**page** | **Integer**| Page number | [optional]
|
|
323
|
-
**per_page** | **Integer**|
|
|
323
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
324
324
|
|
|
325
325
|
### Return type
|
|
326
326
|
|
data/docs/TranslationsApi.md
CHANGED
|
@@ -6,7 +6,7 @@ Method | HTTP request | Description
|
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**translation_create**](TranslationsApi.md#translation_create) | **POST** /projects/{project_id}/translations | Create a translation
|
|
8
8
|
[**translation_exclude**](TranslationsApi.md#translation_exclude) | **PATCH** /projects/{project_id}/translations/{id}/exclude | Exclude a translation from export
|
|
9
|
-
[**translation_include**](TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include |
|
|
9
|
+
[**translation_include**](TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
|
|
10
10
|
[**translation_review**](TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
|
|
11
11
|
[**translation_show**](TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
|
|
12
12
|
[**translation_unverify**](TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
|
|
@@ -14,13 +14,13 @@ Method | HTTP request | Description
|
|
|
14
14
|
[**translation_verify**](TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
|
|
15
15
|
[**translations_by_key**](TranslationsApi.md#translations_by_key) | **GET** /projects/{project_id}/keys/{key_id}/translations | List translations by key
|
|
16
16
|
[**translations_by_locale**](TranslationsApi.md#translations_by_locale) | **GET** /projects/{project_id}/locales/{locale_id}/translations | List translations by locale
|
|
17
|
-
[**translations_exclude_collection**](TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude |
|
|
18
|
-
[**translations_include_collection**](TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include |
|
|
17
|
+
[**translations_exclude_collection**](TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude | Exclude translations by query
|
|
18
|
+
[**translations_include_collection**](TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include | Include translations by query
|
|
19
19
|
[**translations_list**](TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
|
|
20
20
|
[**translations_review_collection**](TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
|
|
21
21
|
[**translations_search**](TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
|
|
22
|
-
[**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify |
|
|
23
|
-
[**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations
|
|
22
|
+
[**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
|
|
23
|
+
[**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -156,7 +156,7 @@ Response<([**TranslationDetails**](TranslationDetails.md))>
|
|
|
156
156
|
|
|
157
157
|
> TranslationDetails translation_include(project_id, id, translation_include_parameters, opts)
|
|
158
158
|
|
|
159
|
-
|
|
159
|
+
Include a translation
|
|
160
160
|
|
|
161
161
|
Remove exclude from export flag from an existing translation.
|
|
162
162
|
|
|
@@ -185,7 +185,7 @@ opts = {
|
|
|
185
185
|
}
|
|
186
186
|
|
|
187
187
|
begin
|
|
188
|
-
#
|
|
188
|
+
#Include a translation
|
|
189
189
|
result = api_instance.translation_include(project_id, id, translation_include_parameters, opts)
|
|
190
190
|
pp result
|
|
191
191
|
rescue Phrase::ApiError => e
|
|
@@ -572,7 +572,7 @@ key_id = 'key_id_example' # String | Translation Key ID
|
|
|
572
572
|
opts = {
|
|
573
573
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
574
574
|
page: 1, # Integer | Page number
|
|
575
|
-
per_page: 25, # Integer |
|
|
575
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
576
576
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
577
577
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
578
578
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
@@ -597,7 +597,7 @@ Name | Type | Description | Notes
|
|
|
597
597
|
**key_id** | **String**| Translation Key ID |
|
|
598
598
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
599
599
|
**page** | **Integer**| Page number | [optional]
|
|
600
|
-
**per_page** | **Integer**|
|
|
600
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
601
601
|
**branch** | **String**| specify the branch to use | [optional]
|
|
602
602
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
603
603
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
@@ -647,11 +647,11 @@ locale_id = 'locale_id_example' # String | Locale ID
|
|
|
647
647
|
opts = {
|
|
648
648
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
649
649
|
page: 1, # Integer | Page number
|
|
650
|
-
per_page: 25, # Integer |
|
|
650
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
651
651
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
652
652
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
653
653
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
654
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
|
654
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
|
655
655
|
}
|
|
656
656
|
|
|
657
657
|
begin
|
|
@@ -672,11 +672,11 @@ Name | Type | Description | Notes
|
|
|
672
672
|
**locale_id** | **String**| Locale ID |
|
|
673
673
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
674
674
|
**page** | **Integer**| Page number | [optional]
|
|
675
|
-
**per_page** | **Integer**|
|
|
675
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
676
676
|
**branch** | **String**| specify the branch to use | [optional]
|
|
677
677
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
678
678
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
679
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
679
|
+
**q** | **String**| Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
680
680
|
|
|
681
681
|
### Return type
|
|
682
682
|
|
|
@@ -696,7 +696,7 @@ Response<([**Array<Translation>**](Translation.md))>
|
|
|
696
696
|
|
|
697
697
|
> AffectedCount translations_exclude_collection(project_id, translations_exclude_parameters, opts)
|
|
698
698
|
|
|
699
|
-
|
|
699
|
+
Exclude translations by query
|
|
700
700
|
|
|
701
701
|
Exclude translations matching query from locale export.
|
|
702
702
|
|
|
@@ -724,7 +724,7 @@ opts = {
|
|
|
724
724
|
}
|
|
725
725
|
|
|
726
726
|
begin
|
|
727
|
-
#
|
|
727
|
+
#Exclude translations by query
|
|
728
728
|
result = api_instance.translations_exclude_collection(project_id, translations_exclude_parameters, opts)
|
|
729
729
|
pp result
|
|
730
730
|
rescue Phrase::ApiError => e
|
|
@@ -759,7 +759,7 @@ Response<([**AffectedCount**](AffectedCount.md))>
|
|
|
759
759
|
|
|
760
760
|
> AffectedCount translations_include_collection(project_id, translations_include_parameters, opts)
|
|
761
761
|
|
|
762
|
-
|
|
762
|
+
Include translations by query
|
|
763
763
|
|
|
764
764
|
Include translations matching query in locale export.
|
|
765
765
|
|
|
@@ -787,7 +787,7 @@ opts = {
|
|
|
787
787
|
}
|
|
788
788
|
|
|
789
789
|
begin
|
|
790
|
-
#
|
|
790
|
+
#Include translations by query
|
|
791
791
|
result = api_instance.translations_include_collection(project_id, translations_include_parameters, opts)
|
|
792
792
|
pp result
|
|
793
793
|
rescue Phrase::ApiError => e
|
|
@@ -846,12 +846,14 @@ api_instance = Phrase::TranslationsApi.new
|
|
|
846
846
|
project_id = 'project_id_example' # String | Project ID
|
|
847
847
|
opts = {
|
|
848
848
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
849
|
+
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
|
850
|
+
if_none_match: 'if_none_match_example', # String | ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
|
849
851
|
page: 1, # Integer | Page number
|
|
850
|
-
per_page: 25, # Integer |
|
|
852
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
851
853
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
852
854
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
853
855
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
854
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
|
856
|
+
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
|
855
857
|
}
|
|
856
858
|
|
|
857
859
|
begin
|
|
@@ -870,12 +872,14 @@ Name | Type | Description | Notes
|
|
|
870
872
|
------------- | ------------- | ------------- | -------------
|
|
871
873
|
**project_id** | **String**| Project ID |
|
|
872
874
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
875
|
+
**if_modified_since** | **String**| Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
|
876
|
+
**if_none_match** | **String**| ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
|
873
877
|
**page** | **Integer**| Page number | [optional]
|
|
874
|
-
**per_page** | **Integer**|
|
|
878
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
875
879
|
**branch** | **String**| specify the branch to use | [optional]
|
|
876
880
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
877
881
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
878
|
-
**q** | **String**| Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
882
|
+
**q** | **String**| Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
879
883
|
|
|
880
884
|
### Return type
|
|
881
885
|
|
|
@@ -984,7 +988,7 @@ translations_search_parameters = Phrase::TranslationsSearchParameters.new # Tran
|
|
|
984
988
|
opts = {
|
|
985
989
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
986
990
|
page: 1, # Integer | Page number
|
|
987
|
-
per_page: 25 # Integer |
|
|
991
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
988
992
|
}
|
|
989
993
|
|
|
990
994
|
begin
|
|
@@ -1005,7 +1009,7 @@ Name | Type | Description | Notes
|
|
|
1005
1009
|
**translations_search_parameters** | [**TranslationsSearchParameters**](TranslationsSearchParameters.md)| |
|
|
1006
1010
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
1007
1011
|
**page** | **Integer**| Page number | [optional]
|
|
1008
|
-
**per_page** | **Integer**|
|
|
1012
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
1009
1013
|
|
|
1010
1014
|
### Return type
|
|
1011
1015
|
|
|
@@ -1025,7 +1029,7 @@ Response<([**Array<Translation>**](Translation.md))>
|
|
|
1025
1029
|
|
|
1026
1030
|
> AffectedCount translations_unverify_collection(project_id, translations_unverify_parameters, opts)
|
|
1027
1031
|
|
|
1028
|
-
|
|
1032
|
+
Unverify translations by query
|
|
1029
1033
|
|
|
1030
1034
|
Mark translations matching query as unverified.
|
|
1031
1035
|
|
|
@@ -1053,7 +1057,7 @@ opts = {
|
|
|
1053
1057
|
}
|
|
1054
1058
|
|
|
1055
1059
|
begin
|
|
1056
|
-
#
|
|
1060
|
+
#Unverify translations by query
|
|
1057
1061
|
result = api_instance.translations_unverify_collection(project_id, translations_unverify_parameters, opts)
|
|
1058
1062
|
pp result
|
|
1059
1063
|
rescue Phrase::ApiError => e
|
|
@@ -1088,7 +1092,7 @@ Response<([**AffectedCount**](AffectedCount.md))>
|
|
|
1088
1092
|
|
|
1089
1093
|
> AffectedCount translations_verify_collection(project_id, translations_verify_parameters, opts)
|
|
1090
1094
|
|
|
1091
|
-
Verify translations
|
|
1095
|
+
Verify translations by query
|
|
1092
1096
|
|
|
1093
1097
|
Verify translations matching query.
|
|
1094
1098
|
|
|
@@ -1116,7 +1120,7 @@ opts = {
|
|
|
1116
1120
|
}
|
|
1117
1121
|
|
|
1118
1122
|
begin
|
|
1119
|
-
#Verify translations
|
|
1123
|
+
#Verify translations by query
|
|
1120
1124
|
result = api_instance.translations_verify_collection(project_id, translations_verify_parameters, opts)
|
|
1121
1125
|
pp result
|
|
1122
1126
|
rescue Phrase::ApiError => e
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
8
|
+
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
9
9
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
10
10
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
8
|
+
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
9
9
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
10
10
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
8
|
+
**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|