phrase 4.22.0 → 4.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -0
- data/README.md +8 -6
- data/docs/AccountDetails.md +1 -1
- data/docs/AuthorizationsApi.md +1 -1
- data/docs/Automation.md +6 -0
- data/docs/AutomationsApi.md +1 -1
- data/docs/AutomationsCreateParameters.md +5 -1
- data/docs/AutomationsCreateParameters1.md +5 -1
- data/docs/BlacklistedKeysApi.md +1 -1
- data/docs/Branch.md +2 -0
- data/docs/BranchCreateParameters.md +3 -1
- data/docs/BranchMergeParameters.md +1 -1
- data/docs/BranchSyncParameters.md +1 -1
- data/docs/BranchesApi.md +10 -10
- data/docs/CommentsApi.md +7 -7
- data/docs/Distribution.md +4 -4
- data/docs/{DistributionPreview.md → DistributionDetails.md} +9 -3
- data/docs/DistributionsApi.md +9 -9
- data/docs/DocumentDelete422Response.md +19 -0
- data/docs/{CustomMetadataPropertyCreate422ResponseErrorsInner.md → DocumentDelete422ResponseErrorsInner.md} +2 -2
- data/docs/DocumentsApi.md +4 -2
- data/docs/FigmaAttachmentsApi.md +1 -1
- data/docs/GlossariesApi.md +1 -1
- data/docs/Glossary.md +2 -0
- data/docs/GlossaryTerm.md +2 -0
- data/docs/GlossaryTermGlossary.md +19 -0
- data/docs/GlossaryTermTranslationsApi.md +1 -1
- data/docs/GlossaryTermsApi.md +1 -1
- data/docs/IcuSkeletonParameters.md +3 -1
- data/docs/Invitation.md +2 -2
- data/docs/InvitationsApi.md +1 -1
- data/docs/Job.md +5 -1
- data/docs/JobDetails.md +8 -2
- data/docs/JobTemplate.md +2 -0
- data/docs/JobTemplateDetails.md +2 -0
- data/docs/JobTemplatesApi.md +1 -1
- data/docs/JobsApi.md +15 -9
- data/docs/KeyCreateParameters.md +6 -2
- data/docs/KeyUpdateParameters.md +6 -2
- data/docs/KeysApi.md +1 -1
- data/docs/LocalesApi.md +6 -2
- data/docs/MembersApi.md +1 -1
- data/docs/NotificationsApi.md +3 -1
- data/docs/OrdersApi.md +4 -2
- data/docs/OrganizationJobTemplate.md +4 -0
- data/docs/OrganizationJobTemplateDetails.md +4 -0
- data/docs/OrganizationJobTemplatesApi.md +1 -1
- data/docs/ProjectCreateParameters.md +17 -1
- data/docs/ProjectDetails.md +7 -1
- data/docs/ProjectUpdateParameters.md +17 -3
- data/docs/ProjectsApi.md +10 -8
- data/docs/Release.md +2 -0
- data/docs/ReleasesApi.md +1 -1
- data/docs/RepoSync.md +2 -0
- data/docs/ScreenshotMarker.md +2 -2
- data/docs/ScreenshotMarkerPresentation.md +23 -0
- data/docs/ScreenshotMarkersApi.md +1 -1
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/docs/ScreenshotsApi.md +1 -1
- data/docs/SearchInAccountParameters.md +3 -1
- data/docs/StyleGuidesApi.md +1 -1
- data/docs/StyleguideCreateParameters.md +3 -3
- data/docs/StyleguideUpdateParameters.md +3 -3
- data/docs/Tag.md +2 -0
- data/docs/TagWithStats.md +2 -0
- data/docs/TagsApi.md +5 -3
- data/docs/TranslationCreateParameters.md +5 -1
- data/docs/TranslationOrder.md +2 -2
- data/docs/TranslationUpdateParameters.md +3 -1
- data/docs/TranslationsApi.md +4 -0
- data/docs/UploadBatch.md +4 -2
- data/docs/UploadsApi.md +3 -1
- data/docs/VariablesApi.md +1 -1
- data/docs/WebhooksApi.md +7 -6
- data/lib/phrase/api/authorizations_api.rb +2 -0
- data/lib/phrase/api/automations_api.rb +2 -0
- data/lib/phrase/api/blacklisted_keys_api.rb +2 -0
- data/lib/phrase/api/branches_api.rb +20 -14
- data/lib/phrase/api/comments_api.rb +18 -4
- data/lib/phrase/api/distributions_api.rb +14 -12
- data/lib/phrase/api/documents_api.rb +5 -0
- data/lib/phrase/api/figma_attachments_api.rb +2 -0
- data/lib/phrase/api/glossaries_api.rb +2 -0
- data/lib/phrase/api/glossary_term_translations_api.rb +2 -0
- data/lib/phrase/api/glossary_terms_api.rb +2 -0
- data/lib/phrase/api/invitations_api.rb +2 -0
- data/lib/phrase/api/job_templates_api.rb +2 -0
- data/lib/phrase/api/jobs_api.rb +18 -6
- data/lib/phrase/api/keys_api.rb +2 -0
- data/lib/phrase/api/locales_api.rb +8 -0
- data/lib/phrase/api/members_api.rb +2 -0
- data/lib/phrase/api/notifications_api.rb +3 -0
- data/lib/phrase/api/orders_api.rb +5 -0
- data/lib/phrase/api/organization_job_templates_api.rb +2 -0
- data/lib/phrase/api/projects_api.rb +23 -10
- data/lib/phrase/api/releases_api.rb +2 -0
- data/lib/phrase/api/screenshot_markers_api.rb +2 -0
- data/lib/phrase/api/screenshots_api.rb +2 -0
- data/lib/phrase/api/style_guides_api.rb +2 -0
- data/lib/phrase/api/tags_api.rb +7 -2
- data/lib/phrase/api/translations_api.rb +6 -0
- data/lib/phrase/api/uploads_api.rb +3 -0
- data/lib/phrase/api/variables_api.rb +2 -0
- data/lib/phrase/api/webhooks_api.rb +9 -5
- data/lib/phrase/models/account_details.rb +1 -0
- data/lib/phrase/models/authorization_create_parameters.rb +22 -0
- data/lib/phrase/models/authorization_update_parameters.rb +22 -0
- data/lib/phrase/models/automation.rb +34 -1
- data/lib/phrase/models/automations_create_parameters.rb +24 -4
- data/lib/phrase/models/automations_create_parameters1.rb +24 -4
- data/lib/phrase/models/branch.rb +46 -1
- data/lib/phrase/models/branch_create_parameters.rb +14 -4
- data/lib/phrase/models/branch_merge_parameters.rb +35 -1
- data/lib/phrase/models/branch_sync_parameters.rb +35 -1
- data/lib/phrase/models/distribution.rb +17 -20
- data/lib/phrase/models/{distribution_preview.rb → distribution_details.rb} +46 -7
- data/lib/phrase/models/{custom_metadata_property_create422_response.rb → document_delete422_response.rb} +4 -4
- data/lib/phrase/models/{custom_metadata_property_create422_response_errors_inner.rb → document_delete422_response_errors_inner.rb} +3 -3
- data/lib/phrase/models/glossary.rb +12 -1
- data/lib/phrase/models/glossary_term.rb +10 -1
- data/lib/phrase/models/glossary_term_glossary.rb +206 -0
- data/lib/phrase/models/icu_skeleton_parameters.rb +12 -2
- data/lib/phrase/models/invitation.rb +9 -8
- data/lib/phrase/models/job.rb +26 -4
- data/lib/phrase/models/job_details.rb +37 -4
- data/lib/phrase/models/job_template.rb +11 -1
- data/lib/phrase/models/job_template_details.rb +11 -1
- data/lib/phrase/models/key_create_parameters.rb +26 -4
- data/lib/phrase/models/key_update_parameters.rb +26 -4
- data/lib/phrase/models/organization_job_template.rb +22 -1
- data/lib/phrase/models/organization_job_template_details.rb +22 -1
- data/lib/phrase/models/project_create_parameters.rb +115 -1
- data/lib/phrase/models/project_details.rb +31 -4
- data/lib/phrase/models/project_update_parameters.rb +75 -5
- data/lib/phrase/models/release.rb +10 -1
- data/lib/phrase/models/repo_sync.rb +12 -1
- data/lib/phrase/models/screenshot_marker.rb +2 -1
- data/lib/phrase/models/screenshot_marker_presentation.rb +224 -0
- data/lib/phrase/models/search_in_account_parameters.rb +16 -4
- data/lib/phrase/models/styleguide_create_parameters.rb +61 -3
- data/lib/phrase/models/styleguide_update_parameters.rb +61 -3
- data/lib/phrase/models/tag.rb +11 -1
- data/lib/phrase/models/tag_with_stats.rb +11 -1
- data/lib/phrase/models/translation_create_parameters.rb +24 -4
- data/lib/phrase/models/translation_order.rb +8 -7
- data/lib/phrase/models/translation_update_parameters.rb +14 -4
- data/lib/phrase/models/upload_batch.rb +24 -14
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +5 -3
- data/spec/api/branches_api_spec.rb +7 -7
- data/spec/api/comments_api_spec.rb +2 -2
- data/spec/api/distributions_api_spec.rb +4 -4
- data/spec/api/documents_api_spec.rb +1 -0
- data/spec/api/jobs_api_spec.rb +4 -2
- data/spec/api/notifications_api_spec.rb +1 -0
- data/spec/api/orders_api_spec.rb +1 -0
- data/spec/api/projects_api_spec.rb +6 -5
- data/spec/api/tags_api_spec.rb +2 -1
- data/spec/api/translations_api_spec.rb +2 -0
- data/spec/api/webhooks_api_spec.rb +2 -2
- data/spec/models/authorization_create_parameters_spec.rb +4 -0
- data/spec/models/authorization_update_parameters_spec.rb +4 -0
- data/spec/models/automation_spec.rb +18 -0
- data/spec/models/automations_create_parameters1_spec.rb +12 -0
- data/spec/models/automations_create_parameters_spec.rb +12 -0
- data/spec/models/branch_create_parameters_spec.rb +6 -0
- data/spec/models/branch_merge_parameters_spec.rb +4 -0
- data/spec/models/branch_spec.rb +10 -0
- data/spec/models/branch_sync_parameters_spec.rb +4 -0
- data/spec/models/{distribution_preview_spec.rb → distribution_details_spec.rb} +24 -6
- data/spec/models/distribution_spec.rb +3 -3
- data/spec/models/{custom_metadata_property_create422_response_errors_inner_spec.rb → document_delete422_response_errors_inner_spec.rb} +6 -6
- data/spec/models/{custom_metadata_property_create422_response_spec.rb → document_delete422_response_spec.rb} +6 -6
- data/spec/models/glossary_spec.rb +6 -0
- data/spec/models/glossary_term_glossary_spec.rb +35 -0
- data/spec/models/glossary_term_spec.rb +6 -0
- data/spec/models/icu_skeleton_parameters_spec.rb +6 -0
- data/spec/models/invitation_spec.rb +1 -1
- data/spec/models/job_details_spec.rb +18 -0
- data/spec/models/job_spec.rb +12 -0
- data/spec/models/job_template_details_spec.rb +6 -0
- data/spec/models/job_template_spec.rb +6 -0
- data/spec/models/key_create_parameters_spec.rb +12 -0
- data/spec/models/key_update_parameters_spec.rb +12 -0
- data/spec/models/organization_job_template_details_spec.rb +12 -0
- data/spec/models/organization_job_template_spec.rb +12 -0
- data/spec/models/project_create_parameters_spec.rb +52 -0
- data/spec/models/project_details_spec.rb +18 -0
- data/spec/models/project_update_parameters_spec.rb +42 -0
- data/spec/models/release_spec.rb +6 -0
- data/spec/models/repo_sync_spec.rb +6 -0
- data/spec/models/screenshot_marker_presentation_spec.rb +47 -0
- data/spec/models/search_in_account_parameters_spec.rb +6 -0
- data/spec/models/styleguide_create_parameters_spec.rb +12 -0
- data/spec/models/styleguide_update_parameters_spec.rb +12 -0
- data/spec/models/tag_spec.rb +6 -0
- data/spec/models/tag_with_stats_spec.rb +6 -0
- data/spec/models/translation_create_parameters_spec.rb +12 -0
- data/spec/models/translation_order_spec.rb +1 -1
- data/spec/models/translation_update_parameters_spec.rb +6 -0
- data/spec/models/upload_batch_spec.rb +8 -2
- metadata +267 -259
- data/docs/CustomMetadataPropertyCreate422Response.md +0 -19
data/docs/ProjectsApi.md
CHANGED
|
@@ -18,7 +18,7 @@ Method | HTTP request | Description
|
|
|
18
18
|
|
|
19
19
|
Create a project
|
|
20
20
|
|
|
21
|
-
Create a new project.
|
|
21
|
+
Create a new project in the given account. When `source_project_id` is supplied, the new project is created as a clone of that project. All locales, keys, and translations are copied asynchronously after the response is returned, so they may not be available immediately. Settings from the source project are inherited unless explicitly overridden in the request; in clone mode, the `shares_translation_memory` field is ignored and inherited from the source. `shares_translation_memory` defaults to `true` when omitted on a non-clone create.
|
|
22
22
|
|
|
23
23
|
### Example
|
|
24
24
|
|
|
@@ -79,7 +79,7 @@ Response<([**ProjectDetails**](ProjectDetails.md))>
|
|
|
79
79
|
|
|
80
80
|
Delete a project
|
|
81
81
|
|
|
82
|
-
Delete an existing project.
|
|
82
|
+
Delete an existing project. Associated repository syncs and OTA distributions are removed. A `project:delete` event is dispatched.
|
|
83
83
|
|
|
84
84
|
### Example
|
|
85
85
|
|
|
@@ -130,7 +130,7 @@ Response<(nil (empty response body))>
|
|
|
130
130
|
### HTTP request headers
|
|
131
131
|
|
|
132
132
|
- **Content-Type**: Not defined
|
|
133
|
-
- **Accept**:
|
|
133
|
+
- **Accept**: application/json
|
|
134
134
|
|
|
135
135
|
|
|
136
136
|
## project_show
|
|
@@ -263,7 +263,7 @@ Response<([**ProjectDetails**](ProjectDetails.md))>
|
|
|
263
263
|
|
|
264
264
|
List projects
|
|
265
265
|
|
|
266
|
-
List all projects the current user has access to.
|
|
266
|
+
List all projects the current user has access to. When the `account_id` query parameter is omitted, the response includes projects across every account the user is a member of. Pass `account_id` to scope the results to a single account.
|
|
267
267
|
|
|
268
268
|
### Example
|
|
269
269
|
|
|
@@ -287,8 +287,9 @@ opts = {
|
|
|
287
287
|
page: 1, # Integer | Page number
|
|
288
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
|
-
sort_by: '
|
|
291
|
-
filters: ['
|
|
290
|
+
sort_by: 'name_asc', # String | Sort projects. Valid values are `name_asc`, `name_desc`, `updated_at_asc`, `updated_at_desc`, `space_asc`, and `space_desc`. The trailing direction segment is optional; if omitted or invalid, projects are sorted ascending. Any other value is ignored and the default ordering is returned.
|
|
291
|
+
filters: ['favorites'], # Array<String> | Filter projects. The only supported value is `favorites`, which restricts the results to projects the current user has starred.
|
|
292
|
+
q: 'name:android' # String | Search query. The only supported syntax is `name:<text>` — for example `name:android` returns projects whose name matches `android` (case-insensitive substring). Any value that does not match the `name:` prefix is ignored.
|
|
292
293
|
}
|
|
293
294
|
|
|
294
295
|
begin
|
|
@@ -309,8 +310,9 @@ Name | Type | Description | Notes
|
|
|
309
310
|
**page** | **Integer**| Page number | [optional]
|
|
310
311
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
311
312
|
**account_id** | **String**| Filter by Account ID | [optional]
|
|
312
|
-
**sort_by** | **String**| Sort projects. Valid
|
|
313
|
-
**filters** | [**Array<String>**](String.md)| Filter projects.
|
|
313
|
+
**sort_by** | **String**| Sort projects. Valid values are `name_asc`, `name_desc`, `updated_at_asc`, `updated_at_desc`, `space_asc`, and `space_desc`. The trailing direction segment is optional; if omitted or invalid, projects are sorted ascending. Any other value is ignored and the default ordering is returned. | [optional]
|
|
314
|
+
**filters** | [**Array<String>**](String.md)| Filter projects. The only supported value is `favorites`, which restricts the results to projects the current user has starred. | [optional]
|
|
315
|
+
**q** | **String**| Search query. The only supported syntax is `name:<text>` — for example `name:android` returns projects whose name matches `android` (case-insensitive substring). Any value that does not match the `name:` prefix is ignored. | [optional]
|
|
314
316
|
|
|
315
317
|
### Return type
|
|
316
318
|
|
data/docs/Release.md
CHANGED
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**environments** | **Array<String>** | | [optional]
|
|
14
14
|
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
|
15
15
|
**tags** | **Array<String>** | | [optional]
|
|
16
|
+
**state** | **String** | | [optional]
|
|
16
17
|
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
|
17
18
|
**created_at** | **Time** | | [optional]
|
|
18
19
|
**updated_at** | **Time** | | [optional]
|
|
@@ -31,6 +32,7 @@ instance = Phrase::Release.new(id: null,
|
|
|
31
32
|
environments: null,
|
|
32
33
|
locales: null,
|
|
33
34
|
tags: null,
|
|
35
|
+
state: null,
|
|
34
36
|
project: null,
|
|
35
37
|
created_at: null,
|
|
36
38
|
updated_at: null)
|
data/docs/ReleasesApi.md
CHANGED
data/docs/RepoSync.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**enabled** | **Boolean** | | [optional]
|
|
11
11
|
**auto_import** | **Boolean** | | [optional]
|
|
12
12
|
**repo_name** | **String** | | [optional]
|
|
13
|
+
**pr_branch** | **String** | Branch used as the source of exports/PRs. May be `null` when the sync is configured to push directly to `base_branch`. | [optional]
|
|
13
14
|
**created_at** | **Time** | | [optional]
|
|
14
15
|
**last_import_at** | **Time** | | [optional]
|
|
15
16
|
**last_export_at** | **Time** | | [optional]
|
|
@@ -25,6 +26,7 @@ instance = Phrase::RepoSync.new(id: null,
|
|
|
25
26
|
enabled: null,
|
|
26
27
|
auto_import: null,
|
|
27
28
|
repo_name: null,
|
|
29
|
+
pr_branch: null,
|
|
28
30
|
created_at: null,
|
|
29
31
|
last_import_at: null,
|
|
30
32
|
last_export_at: null)
|
data/docs/ScreenshotMarker.md
CHANGED
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **String** | | [optional]
|
|
8
|
-
**presentation** | **
|
|
9
|
-
**presentation_type** | **String** | | [optional]
|
|
8
|
+
**presentation** | [**ScreenshotMarkerPresentation**](ScreenshotMarkerPresentation.md) | | [optional]
|
|
9
|
+
**presentation_type** | **String** | Marker presentation style. The default value is `default`. | [optional]
|
|
10
10
|
**created_at** | **Time** | | [optional]
|
|
11
11
|
**updated_at** | **Time** | | [optional]
|
|
12
12
|
**translation_key** | [**TranslationKey**](TranslationKey.md) | | [optional]
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Phrase::ScreenshotMarkerPresentation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**x** | **Integer** | | [optional]
|
|
8
|
+
**y** | **Integer** | | [optional]
|
|
9
|
+
**w** | **Integer** | | [optional]
|
|
10
|
+
**h** | **Integer** | | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'Phrase'
|
|
16
|
+
|
|
17
|
+
instance = Phrase::ScreenshotMarkerPresentation.new(x: null,
|
|
18
|
+
y: null,
|
|
19
|
+
w: null,
|
|
20
|
+
h: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
data/docs/ScreenshotsApi.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**locale_code** | **String** | Locale code | [optional]
|
|
9
9
|
**page** | **Integer** | Page | [optional]
|
|
10
10
|
**per_page** | **Integer** | Number of results per page | [optional]
|
|
11
|
+
**project_ids** | **Array<String>** | Limit the search to the given project codes. When omitted, the search spans every project the user can access in this account. | [optional]
|
|
11
12
|
|
|
12
13
|
## Code Sample
|
|
13
14
|
|
|
@@ -17,7 +18,8 @@ require 'Phrase'
|
|
|
17
18
|
instance = Phrase::SearchInAccountParameters.new(query: keyword,
|
|
18
19
|
locale_code: de_DE,
|
|
19
20
|
page: 1,
|
|
20
|
-
per_page: 25
|
|
21
|
+
per_page: 25,
|
|
22
|
+
project_ids: ["abcd1234abcd1234abcd1234abcd1234"])
|
|
21
23
|
```
|
|
22
24
|
|
|
23
25
|
|
data/docs/StyleGuidesApi.md
CHANGED
|
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**title** | **String** | Style guide title |
|
|
8
8
|
**audience** | **String** | Audience description | [optional]
|
|
9
|
-
**target_audience** | **String** |
|
|
10
|
-
**grammatical_person** | **String** |
|
|
11
|
-
**vocabulary_type** | **String** |
|
|
9
|
+
**target_audience** | **String** | Target audience for the translations. | [optional]
|
|
10
|
+
**grammatical_person** | **String** | Preferred grammatical person. | [optional]
|
|
11
|
+
**vocabulary_type** | **String** | Vocabulary register the translations should use. | [optional]
|
|
12
12
|
**business** | **String** | Description of the business | [optional]
|
|
13
13
|
**company_branding** | **String** | Company branding to remain consistent. | [optional]
|
|
14
14
|
**formatting** | **String** | Formatting requirements and character limitations. | [optional]
|
|
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**title** | **String** | Style guide title | [optional]
|
|
8
8
|
**audience** | **String** | Audience description | [optional]
|
|
9
|
-
**target_audience** | **String** |
|
|
10
|
-
**grammatical_person** | **String** |
|
|
11
|
-
**vocabulary_type** | **String** |
|
|
9
|
+
**target_audience** | **String** | Target audience for the translations. | [optional]
|
|
10
|
+
**grammatical_person** | **String** | Preferred grammatical person. | [optional]
|
|
11
|
+
**vocabulary_type** | **String** | Vocabulary register the translations should use. | [optional]
|
|
12
12
|
**business** | **String** | Description of the business | [optional]
|
|
13
13
|
**company_branding** | **String** | Company branding to remain consistent. | [optional]
|
|
14
14
|
**formatting** | **String** | Formatting requirements and character limitations. | [optional]
|
data/docs/Tag.md
CHANGED
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | | [optional]
|
|
8
8
|
**keys_count** | **Integer** | | [optional]
|
|
9
|
+
**system_tag** | **Boolean** | `true` when the tag was created automatically by the system (e.g. for jobs, uploads, or Figma attachments) rather than by a user. | [optional]
|
|
9
10
|
**created_at** | **Time** | | [optional]
|
|
10
11
|
**updated_at** | **Time** | | [optional]
|
|
11
12
|
|
|
@@ -16,6 +17,7 @@ require 'Phrase'
|
|
|
16
17
|
|
|
17
18
|
instance = Phrase::Tag.new(name: null,
|
|
18
19
|
keys_count: null,
|
|
20
|
+
system_tag: null,
|
|
19
21
|
created_at: null,
|
|
20
22
|
updated_at: null)
|
|
21
23
|
```
|
data/docs/TagWithStats.md
CHANGED
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | | [optional]
|
|
8
8
|
**keys_count** | **Integer** | | [optional]
|
|
9
|
+
**system_tag** | **Boolean** | `true` when the tag was created automatically by the system (e.g. for jobs, uploads, or Figma attachments) rather than by a user. | [optional]
|
|
9
10
|
**created_at** | **Time** | | [optional]
|
|
10
11
|
**updated_at** | **Time** | | [optional]
|
|
11
12
|
**statistics** | [**Array<TagWithStats1Statistics1>**](TagWithStats1Statistics1.md) | | [optional]
|
|
@@ -17,6 +18,7 @@ require 'Phrase'
|
|
|
17
18
|
|
|
18
19
|
instance = Phrase::TagWithStats.new(name: null,
|
|
19
20
|
keys_count: null,
|
|
21
|
+
system_tag: null,
|
|
20
22
|
created_at: null,
|
|
21
23
|
updated_at: null,
|
|
22
24
|
statistics: null)
|
data/docs/TagsApi.md
CHANGED
|
@@ -135,7 +135,7 @@ Response<(nil (empty response body))>
|
|
|
135
135
|
### HTTP request headers
|
|
136
136
|
|
|
137
137
|
- **Content-Type**: Not defined
|
|
138
|
-
- **Accept**:
|
|
138
|
+
- **Accept**: application/json
|
|
139
139
|
|
|
140
140
|
|
|
141
141
|
## tag_show
|
|
@@ -235,7 +235,8 @@ opts = {
|
|
|
235
235
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
236
236
|
page: 1, # Integer | Page number
|
|
237
237
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
238
|
-
exclude_system_tags: true, # Boolean |
|
|
238
|
+
exclude_system_tags: true, # Boolean | Excludes tags generated by the system, e.g. job, upload or figma tags. Mutually exclusive with `only_system_tags`.
|
|
239
|
+
only_system_tags: false, # Boolean | Returns only system-generated tags (e.g. job, upload, figma) and excludes user-defined tags. Mutually exclusive with `exclude_system_tags`.
|
|
239
240
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
240
241
|
q: 'feature' # String | Specify a query to filter tags by name.
|
|
241
242
|
}
|
|
@@ -258,7 +259,8 @@ Name | Type | Description | Notes
|
|
|
258
259
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
259
260
|
**page** | **Integer**| Page number | [optional]
|
|
260
261
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
261
|
-
**exclude_system_tags** | **Boolean**|
|
|
262
|
+
**exclude_system_tags** | **Boolean**| Excludes tags generated by the system, e.g. job, upload or figma tags. Mutually exclusive with `only_system_tags`. | [optional]
|
|
263
|
+
**only_system_tags** | **Boolean**| Returns only system-generated tags (e.g. job, upload, figma) and excludes user-defined tags. Mutually exclusive with `exclude_system_tags`. | [optional]
|
|
262
264
|
**branch** | **String**| specify the branch to use | [optional]
|
|
263
265
|
**q** | **String**| Specify a query to filter tags by name. | [optional]
|
|
264
266
|
|
|
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**unverified** | **Boolean** | Indicates whether translation is unverified. Part of the [Advanced Workflows](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
|
|
13
13
|
**excluded** | **Boolean** | Indicates whether translation is excluded. | [optional]
|
|
14
14
|
**autotranslate** | **Boolean** | Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled. | [optional]
|
|
15
|
+
**minor_change** | **Boolean** | When `true`, the translation is marked as a minor edit and does not trigger downstream re-verification on the linked locales' translations. | [optional]
|
|
16
|
+
**reviewed** | **Boolean** | When `true` and the project's review workflow is enabled, the translation is created in the `reviewed` state. | [optional]
|
|
15
17
|
|
|
16
18
|
## Code Sample
|
|
17
19
|
|
|
@@ -25,7 +27,9 @@ instance = Phrase::TranslationCreateParameters.new(branch: my-feature-branch,
|
|
|
25
27
|
plural_suffix: null,
|
|
26
28
|
unverified: null,
|
|
27
29
|
excluded: null,
|
|
28
|
-
autotranslate: null
|
|
30
|
+
autotranslate: null,
|
|
31
|
+
minor_change: false,
|
|
32
|
+
reviewed: false)
|
|
29
33
|
```
|
|
30
34
|
|
|
31
35
|
|
data/docs/TranslationOrder.md
CHANGED
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**progress_percent** | **Integer** | | [optional]
|
|
16
16
|
**source_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
|
17
17
|
**target_locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
|
18
|
-
**
|
|
18
|
+
**tag_name** | **String** | Name of the tag whose keys are included in the order. | [optional]
|
|
19
19
|
**styleguide** | [**StyleguidePreview**](StyleguidePreview.md) | | [optional]
|
|
20
20
|
**unverify_translations_upon_delivery** | **Boolean** | | [optional]
|
|
21
21
|
**quality** | **Boolean** | | [optional]
|
|
@@ -39,7 +39,7 @@ instance = Phrase::TranslationOrder.new(id: null,
|
|
|
39
39
|
progress_percent: null,
|
|
40
40
|
source_locale: null,
|
|
41
41
|
target_locales: null,
|
|
42
|
-
|
|
42
|
+
tag_name: null,
|
|
43
43
|
styleguide: null,
|
|
44
44
|
unverify_translations_upon_delivery: null,
|
|
45
45
|
quality: null,
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**excluded** | **Boolean** | Indicates whether translation is excluded. | [optional]
|
|
12
12
|
**autotranslate** | **Boolean** | Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled. | [optional]
|
|
13
13
|
**reviewed** | **Boolean** | When set to `true`, the translation will be marked as reviewed. | [optional]
|
|
14
|
+
**minor_change** | **Boolean** | When `true`, the update is treated as a minor edit and does not trigger downstream re-verification on the linked locales' translations. | [optional]
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
@@ -23,7 +24,8 @@ instance = Phrase::TranslationUpdateParameters.new(branch: my-feature-branch,
|
|
|
23
24
|
unverified: null,
|
|
24
25
|
excluded: null,
|
|
25
26
|
autotranslate: null,
|
|
26
|
-
reviewed: true
|
|
27
|
+
reviewed: true,
|
|
28
|
+
minor_change: false)
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
|
data/docs/TranslationsApi.md
CHANGED
|
@@ -918,6 +918,8 @@ opts = {
|
|
|
918
918
|
page: 1, # Integer | Page number
|
|
919
919
|
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
920
920
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
921
|
+
key_id: 'abcd1234cdef1234abcd1234cdef1234', # String | Filter translations to those attached to the key identified by this code. Equivalent to calling `GET /projects/{project_id}/keys/{key_id}/translations`.
|
|
922
|
+
locale_id: 'abcd1234cdef1234abcd1234cdef1234', # String | Filter translations to those for the given locale (locale code or id). Equivalent to calling `GET /projects/{project_id}/locales/{locale_id}/translations`.
|
|
921
923
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
922
924
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
923
925
|
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples).
|
|
@@ -944,6 +946,8 @@ Name | Type | Description | Notes
|
|
|
944
946
|
**page** | **Integer**| Page number | [optional]
|
|
945
947
|
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
|
946
948
|
**branch** | **String**| specify the branch to use | [optional]
|
|
949
|
+
**key_id** | **String**| Filter translations to those attached to the key identified by this code. Equivalent to calling `GET /projects/{project_id}/keys/{key_id}/translations`. | [optional]
|
|
950
|
+
**locale_id** | **String**| Filter translations to those for the given locale (locale code or id). Equivalent to calling `GET /projects/{project_id}/locales/{locale_id}/translations`. | [optional]
|
|
947
951
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
948
952
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
949
953
|
**q** | **String**| Specify a query to find translations by content (including wildcards). *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).* The following qualifiers are supported in the query: * `id:translation_id,...` for queries on a comma-separated list of ids * `tags:XYZ` for tags on the translation * `unverified:{true|false}` for verification status * `excluded:{true|false}` for exclusion status * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp Find more examples [here](/en/api/strings/usage-examples). | [optional]
|
data/docs/UploadBatch.md
CHANGED
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
7
|
+
**status** | **String** | Processing state of the upload batch | [optional]
|
|
8
8
|
**delete_unmentioned_keys** | **Boolean** | Indicates whether unmentioned keys will be deleted after processing all uploads in the batch | [optional]
|
|
9
|
+
**uploads_count** | **Integer** | Number of uploads attached to this batch. | [optional]
|
|
9
10
|
**created_at** | **Time** | | [optional]
|
|
10
11
|
**updated_at** | **Time** | | [optional]
|
|
11
12
|
**project** | [**ProjectShort**](.md) | | [optional]
|
|
@@ -17,8 +18,9 @@ Name | Type | Description | Notes
|
|
|
17
18
|
```ruby
|
|
18
19
|
require 'Phrase'
|
|
19
20
|
|
|
20
|
-
instance = Phrase::UploadBatch.new(
|
|
21
|
+
instance = Phrase::UploadBatch.new(status: null,
|
|
21
22
|
delete_unmentioned_keys: null,
|
|
23
|
+
uploads_count: null,
|
|
22
24
|
created_at: null,
|
|
23
25
|
updated_at: null,
|
|
24
26
|
project: null,
|
data/docs/UploadsApi.md
CHANGED
|
@@ -59,7 +59,8 @@ opts = {
|
|
|
59
59
|
verify_mentioned_translations: true, # Boolean | Indicates whether all translations mentioned in the upload should be verified.
|
|
60
60
|
mark_reviewed: true, # Boolean | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
|
|
61
61
|
tag_only_affected_keys: true, # Boolean | Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
|
|
62
|
-
translation_key_prefix: 'translation_key_prefix_example' # String | This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized.
|
|
62
|
+
translation_key_prefix: 'translation_key_prefix_example', # String | This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized.
|
|
63
|
+
skip_automated_job_creation: true # Boolean | When `true`, the automation rules for the project will not fire for this upload, so no jobs are created as a side effect of importing this file. Defaults to `false`.
|
|
63
64
|
}
|
|
64
65
|
|
|
65
66
|
begin
|
|
@@ -100,6 +101,7 @@ Name | Type | Description | Notes
|
|
|
100
101
|
**mark_reviewed** | **Boolean**| Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project. | [optional]
|
|
101
102
|
**tag_only_affected_keys** | **Boolean**| Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false` | [optional] [default to false]
|
|
102
103
|
**translation_key_prefix** | **String**| This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized. | [optional]
|
|
104
|
+
**skip_automated_job_creation** | **Boolean**| When `true`, the automation rules for the project will not fire for this upload, so no jobs are created as a side effect of importing this file. Defaults to `false`. | [optional] [default to false]
|
|
103
105
|
|
|
104
106
|
### Return type
|
|
105
107
|
|
data/docs/VariablesApi.md
CHANGED
data/docs/WebhooksApi.md
CHANGED
|
@@ -135,7 +135,7 @@ Response<(nil (empty response body))>
|
|
|
135
135
|
### HTTP request headers
|
|
136
136
|
|
|
137
137
|
- **Content-Type**: Not defined
|
|
138
|
-
- **Accept**:
|
|
138
|
+
- **Accept**: application/json
|
|
139
139
|
|
|
140
140
|
|
|
141
141
|
## webhook_show
|
|
@@ -203,11 +203,11 @@ Response<([**Webhook**](Webhook.md))>
|
|
|
203
203
|
|
|
204
204
|
## webhook_test
|
|
205
205
|
|
|
206
|
-
> webhook_test(project_id, id, opts)
|
|
206
|
+
> Webhook webhook_test(project_id, id, opts)
|
|
207
207
|
|
|
208
208
|
Test a webhook
|
|
209
209
|
|
|
210
|
-
Perform a test request for a webhook.
|
|
210
|
+
Perform a test request for a webhook. Sends a synthetic `test:event` payload to the webhook's `callback_url` and returns the webhook resource.
|
|
211
211
|
|
|
212
212
|
### Example
|
|
213
213
|
|
|
@@ -234,7 +234,8 @@ opts = {
|
|
|
234
234
|
|
|
235
235
|
begin
|
|
236
236
|
#Test a webhook
|
|
237
|
-
api_instance.webhook_test(project_id, id, opts)
|
|
237
|
+
result = api_instance.webhook_test(project_id, id, opts)
|
|
238
|
+
pp result
|
|
238
239
|
rescue Phrase::ApiError => e
|
|
239
240
|
puts "Exception when calling WebhooksApi->webhook_test: #{e}"
|
|
240
241
|
end
|
|
@@ -251,7 +252,7 @@ Name | Type | Description | Notes
|
|
|
251
252
|
|
|
252
253
|
### Return type
|
|
253
254
|
|
|
254
|
-
Response<(
|
|
255
|
+
Response<([**Webhook**](Webhook.md))>
|
|
255
256
|
|
|
256
257
|
### Authorization
|
|
257
258
|
|
|
@@ -260,7 +261,7 @@ Response<(nil (empty response body))>
|
|
|
260
261
|
### HTTP request headers
|
|
261
262
|
|
|
262
263
|
- **Content-Type**: Not defined
|
|
263
|
-
- **Accept**:
|
|
264
|
+
- **Accept**: application/json
|
|
264
265
|
|
|
265
266
|
|
|
266
267
|
## webhook_update
|
|
@@ -108,6 +108,8 @@ module Phrase
|
|
|
108
108
|
|
|
109
109
|
# header parameters
|
|
110
110
|
header_params = opts[:header_params] || {}
|
|
111
|
+
# HTTP header 'Accept' (if needed)
|
|
112
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
111
113
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
112
114
|
|
|
113
115
|
# form parameters
|
|
@@ -406,6 +406,8 @@ module Phrase
|
|
|
406
406
|
|
|
407
407
|
# header parameters
|
|
408
408
|
header_params = opts[:header_params] || {}
|
|
409
|
+
# HTTP header 'Accept' (if needed)
|
|
410
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
409
411
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
410
412
|
|
|
411
413
|
# form parameters
|
|
@@ -120,6 +120,8 @@ module Phrase
|
|
|
120
120
|
|
|
121
121
|
# header parameters
|
|
122
122
|
header_params = opts[:header_params] || {}
|
|
123
|
+
# HTTP header 'Accept' (if needed)
|
|
124
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
123
125
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
124
126
|
|
|
125
127
|
# form parameters
|