phrase 4.29.0 → 4.30.1
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 +14 -0
- data/README.md +4 -4
- data/docs/Account.md +8 -8
- data/docs/AccountDetails.md +10 -10
- data/docs/AccountSearchResult.md +8 -8
- data/docs/AffectedCount.md +2 -2
- data/docs/AffectedResources.md +2 -2
- data/docs/Authorization.md +9 -9
- data/docs/AuthorizationCreateParameters.md +4 -4
- data/docs/AuthorizationUpdateParameters.md +4 -4
- data/docs/AuthorizationWithToken.md +10 -10
- data/docs/Automation.md +17 -17
- data/docs/AutomationEvent.md +10 -10
- data/docs/AutomationEventProject.md +3 -3
- data/docs/AutomationsCreateParameters.md +10 -10
- data/docs/AutomationsCreateParameters1.md +10 -10
- data/docs/BlacklistedKey.md +5 -5
- data/docs/BlacklistedKeyCreateParameters.md +2 -2
- data/docs/BlacklistedKeyUpdateParameters.md +2 -2
- data/docs/Branch.md +12 -12
- data/docs/BranchComparison.md +5 -5
- data/docs/BranchComparisonChange.md +3 -3
- data/docs/BranchComparisonDiff.md +4 -4
- data/docs/BranchComparisonDiffConflictsValue.md +3 -3
- data/docs/BranchCreateComparisonParameters.md +2 -2
- data/docs/BranchCreateParameters.md +3 -3
- data/docs/BranchMergeParameters.md +2 -2
- data/docs/BranchName.md +2 -2
- data/docs/BranchSyncParameters.md +2 -2
- data/docs/BranchUpdateParameters.md +2 -2
- data/docs/CheckIssue.md +10 -10
- data/docs/Comment.md +9 -9
- data/docs/CommentCreateParameters.md +4 -4
- data/docs/CommentCreateParameters1.md +3 -3
- data/docs/CommentMarkReadParameters.md +2 -2
- data/docs/CommentReaction.md +7 -7
- data/docs/CommentUpdateParameters.md +3 -3
- data/docs/CurrentUser.md +9 -9
- data/docs/CustomMetadataDataType.md +1 -1
- data/docs/CustomMetadataPropertiesCreateParameters.md +6 -6
- data/docs/CustomMetadataPropertiesUpdateParameters.md +5 -5
- data/docs/CustomMetadataProperty.md +10 -10
- data/docs/Distribution.md +9 -9
- data/docs/DistributionCreateParameters.md +6 -6
- data/docs/DistributionDetails.md +11 -11
- data/docs/DistributionUpdateParameters.md +6 -6
- data/docs/Document.md +5 -5
- data/docs/DocumentDelete422Response.md +3 -3
- data/docs/DocumentDelete422ResponseErrorsInner.md +4 -4
- data/docs/Error.md +2 -2
- data/docs/ErrorError.md +3 -3
- data/docs/FigmaAttachment.md +5 -5
- data/docs/FigmaAttachmentCreateParameters.md +3 -3
- data/docs/FigmaAttachmentUpdateParameters.md +3 -3
- data/docs/Format.md +7 -7
- data/docs/Glossary.md +7 -7
- data/docs/GlossaryCreateParameters.md +4 -4
- data/docs/GlossaryTerm.md +10 -10
- data/docs/GlossaryTermCreateParameters.md +3 -3
- data/docs/GlossaryTermGlossary.md +3 -3
- data/docs/GlossaryTermTranslation.md +6 -6
- data/docs/GlossaryTermTranslationCreateParameters.md +3 -3
- data/docs/GlossaryTermTranslationUpdateParameters.md +3 -3
- data/docs/GlossaryTermUpdateParameters.md +3 -3
- data/docs/GlossaryUpdateParameters.md +4 -4
- data/docs/Icu.md +2 -2
- data/docs/IcuSkeletonError.md +2 -2
- data/docs/IcuSkeletonParameters.md +5 -5
- data/docs/Invitation.md +16 -16
- data/docs/InvitationCreateParameters.md +9 -9
- data/docs/InvitationUpdateParameters.md +8 -8
- data/docs/InvitationUpdateSettingsParameters.md +3 -3
- data/docs/Job.md +14 -14
- data/docs/JobAnnotation.md +5 -5
- data/docs/JobAnnotationShort.md +3 -3
- data/docs/JobAnnotationUpdateParameters.md +3 -3
- data/docs/JobComment.md +8 -8
- data/docs/JobCommentCreateParameters.md +3 -3
- data/docs/JobCommentUpdateParameters.md +3 -3
- data/docs/JobCompleteParameters.md +2 -2
- data/docs/JobCreateParameters.md +11 -11
- data/docs/JobDetails.md +22 -22
- data/docs/JobKeysCreateParameters.md +3 -3
- data/docs/JobKeysDeleteParameters.md +3 -3
- data/docs/JobLocale.md +10 -10
- data/docs/JobLocaleCompleteParameters.md +2 -2
- data/docs/JobLocaleCompleteReviewParameters.md +2 -2
- data/docs/JobLocaleReopenParameters.md +2 -2
- data/docs/JobLocaleUpdateParameters.md +7 -7
- data/docs/JobLocalesCreateParameters.md +7 -7
- data/docs/JobPreview.md +4 -4
- data/docs/JobReopenParameters.md +2 -2
- data/docs/JobStartParameters.md +2 -2
- data/docs/JobTemplate.md +9 -9
- data/docs/JobTemplateCreateParameters.md +6 -6
- data/docs/JobTemplateDetails.md +12 -12
- data/docs/JobTemplateLocaleUpdateParameters.md +7 -7
- data/docs/JobTemplateLocales.md +6 -6
- data/docs/JobTemplateLocalesCreateParameters.md +7 -7
- data/docs/JobTemplatePreview.md +3 -3
- data/docs/JobTemplateUpdateParameters.md +6 -6
- data/docs/JobUpdateParameters.md +6 -8
- data/docs/JobsApi.md +3 -1
- data/docs/KeyCreateParameters.md +21 -21
- data/docs/KeyFormatAnnotationsList200ResponseInner.md +3 -3
- data/docs/KeyLink.md +8 -8
- data/docs/KeyLinksBatchDestroyParameters.md +4 -4
- data/docs/KeyLinksCreateParameters.md +2 -2
- data/docs/KeyPreview.md +5 -5
- data/docs/KeyUpdateParameters.md +19 -19
- data/docs/KeysExcludeParameters.md +5 -5
- data/docs/KeysIncludeParameters.md +5 -5
- data/docs/KeysSearchParameters.md +6 -6
- data/docs/KeysTagParameters.md +5 -5
- data/docs/KeysUntagParameters.md +5 -5
- data/docs/Locale.md +17 -17
- data/docs/LocaleCreateParameters.md +16 -16
- data/docs/LocaleDetails.md +18 -18
- data/docs/LocaleDownload.md +8 -8
- data/docs/LocaleDownloadCreateParameters.md +14 -14
- data/docs/LocaleDownloadParams.md +8 -8
- data/docs/LocaleDownloadResult.md +2 -2
- data/docs/LocalePreview.md +4 -4
- data/docs/LocalePreview1.md +3 -3
- data/docs/LocaleReport.md +15 -15
- data/docs/LocaleStatistics.md +8 -8
- data/docs/LocaleTeamPreview.md +4 -4
- data/docs/LocaleUpdateParameters.md +14 -14
- data/docs/LocaleUserPreview.md +5 -5
- data/docs/MachineTranslationLocaleProviderMapping.md +4 -4
- data/docs/MachineTranslationLocaleProviderMappingsCreateParameters.md +4 -4
- data/docs/MachineTranslationSettings.md +3 -3
- data/docs/MachineTranslationSettingsUpdateParameters.md +2 -2
- data/docs/Member.md +12 -12
- data/docs/MemberProjectDetail.md +11 -11
- data/docs/MemberProjectDetailProjectRolesInner.md +3 -3
- data/docs/MemberSpacesInner.md +6 -6
- data/docs/MemberUpdateParameters.md +8 -8
- data/docs/MemberUpdateSettingsParameters.md +3 -3
- data/docs/Notification.md +14 -14
- data/docs/NotificationGroup.md +5 -5
- data/docs/NotificationGroupDetail.md +7 -7
- data/docs/OrderConfirmParameters.md +2 -2
- data/docs/OrderCreateParameters.md +16 -16
- data/docs/OrganizationJobTemplate.md +8 -8
- data/docs/OrganizationJobTemplateCreateParameters.md +4 -4
- data/docs/OrganizationJobTemplateDetails.md +11 -11
- data/docs/OrganizationJobTemplateLocaleUpdateParameters.md +7 -7
- data/docs/OrganizationJobTemplateLocalesCreateParameters.md +7 -7
- data/docs/OrganizationJobTemplateUpdateParameters.md +4 -4
- data/docs/PreTranslation.md +8 -8
- data/docs/PreTranslationCreateParameters.md +3 -3
- data/docs/Project.md +12 -12
- data/docs/ProjectCreateParameters.md +16 -16
- data/docs/ProjectDetails.md +18 -18
- data/docs/ProjectLocales.md +8 -8
- data/docs/ProjectMember.md +7 -7
- data/docs/ProjectReport.md +9 -9
- data/docs/ProjectShort.md +6 -6
- data/docs/ProjectUpdateParameters.md +14 -14
- data/docs/QualityPerformanceScoreList200Response.md +4 -4
- data/docs/QualityPerformanceScoreList200ResponseAnyOf.md +3 -3
- data/docs/QualityPerformanceScoreList200ResponseAnyOfData.md +2 -2
- data/docs/QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner.md +4 -4
- data/docs/QualityPerformanceScoreList200ResponseAnyOfErrorsInner.md +4 -4
- data/docs/QualityPerformanceScoreListRequest.md +2 -2
- data/docs/Release.md +14 -14
- data/docs/ReleaseCreateParameters.md +8 -8
- data/docs/ReleaseCreateParameters1.md +8 -8
- data/docs/ReleasePreview.md +13 -13
- data/docs/ReleaseTrigger.md +12 -12
- data/docs/ReleaseUpdateParameters.md +6 -6
- data/docs/ReleaseUpdateParameters1.md +8 -8
- data/docs/RepoSync.md +12 -12
- data/docs/RepoSyncCreateParameters.md +10 -10
- data/docs/RepoSyncEvent.md +8 -8
- data/docs/RepoSyncExportParameters.md +3 -3
- data/docs/RepoSyncImportParameters.md +3 -3
- data/docs/RepoSyncsApi.md +5 -1
- data/docs/ReportsApi.md +4 -4
- data/docs/Screenshot.md +8 -8
- data/docs/ScreenshotMarker.md +7 -7
- data/docs/ScreenshotMarkerCreateParameters.md +4 -4
- data/docs/ScreenshotMarkerPresentation.md +5 -5
- data/docs/ScreenshotMarkerUpdateParameters.md +4 -4
- data/docs/ScreenshotUpdateParameters.md +5 -5
- data/docs/SearchInAccountParameters.md +4 -4
- data/docs/Space.md +7 -7
- data/docs/Space1.md +6 -6
- data/docs/SpaceCreateParameters.md +2 -2
- data/docs/SpaceUpdateParameters.md +2 -2
- data/docs/SpacesProjectsCreateParameters.md +2 -2
- data/docs/Styleguide.md +5 -5
- data/docs/StyleguideCreateParameters.md +14 -14
- data/docs/StyleguideDetails.md +18 -18
- data/docs/StyleguidePreview.md +3 -3
- data/docs/StyleguideUpdateParameters.md +14 -14
- data/docs/Subscription.md +3 -3
- data/docs/Tag.md +6 -6
- data/docs/TagCreateParameters.md +3 -3
- data/docs/TagWithStats.md +7 -7
- data/docs/TagWithStats1Statistics.md +5 -5
- data/docs/TagWithStats1Statistics1.md +3 -3
- data/docs/Team.md +8 -8
- data/docs/TeamCreateParameters.md +2 -2
- data/docs/TeamDetail.md +8 -8
- data/docs/TeamShort.md +5 -5
- data/docs/TeamUpdateParameters.md +2 -2
- data/docs/TeamsProjectsCreateParameters.md +2 -2
- data/docs/TeamsSpacesCreateParameters.md +2 -2
- data/docs/TeamsUsersCreateParameters.md +2 -2
- data/docs/Translation.md +13 -13
- data/docs/TranslationCreateParameters.md +9 -9
- data/docs/TranslationDetails.md +15 -15
- data/docs/TranslationExcludeParameters.md +2 -2
- data/docs/TranslationIncludeParameters.md +2 -2
- data/docs/TranslationKey.md +11 -11
- data/docs/TranslationKeyDetails.md +21 -21
- data/docs/TranslationOrder.md +19 -19
- data/docs/TranslationParent.md +3 -3
- data/docs/TranslationReviewParameters.md +2 -2
- data/docs/TranslationUnreviewParameters.md +2 -2
- data/docs/TranslationUnverifyParameters.md +2 -2
- data/docs/TranslationUpdateParameters.md +7 -7
- data/docs/TranslationVerifyParameters.md +2 -2
- data/docs/TranslationVersion.md +9 -9
- data/docs/TranslationVersionWithUser.md +10 -10
- data/docs/TranslationsExcludeParameters.md +5 -5
- data/docs/TranslationsIncludeParameters.md +5 -5
- data/docs/TranslationsReviewParameters.md +3 -3
- data/docs/TranslationsSearchParameters.md +5 -5
- data/docs/TranslationsUnreviewParameters.md +3 -3
- data/docs/TranslationsUnverifyParameters.md +5 -5
- data/docs/TranslationsVerifyParameters.md +4 -4
- data/docs/Upload.md +13 -13
- data/docs/UploadBatch.md +9 -9
- data/docs/UploadBatchesCreateParameters.md +3 -3
- data/docs/UploadSummary.md +11 -11
- data/docs/UploadsApi.md +2 -2
- data/docs/User.md +7 -7
- data/docs/UserPreview.md +5 -5
- data/docs/Variable.md +5 -5
- data/docs/VariableCreateParameters.md +3 -3
- data/docs/VariableUpdateParameters.md +3 -3
- data/docs/Webhook.md +9 -9
- data/docs/WebhookCreateParameters.md +7 -7
- data/docs/WebhookDelivery.md +8 -8
- data/docs/WebhookUpdateParameters.md +7 -7
- data/lib/phrase/api/jobs_api.rb +3 -0
- data/lib/phrase/api/repo_syncs_api.rb +6 -0
- data/lib/phrase/api/reports_api.rb +4 -4
- data/lib/phrase/models/job_update_parameters.rb +1 -11
- data/lib/phrase/models/locale_create_parameters.rb +2 -2
- data/lib/phrase/version.rb +1 -1
- data/spec/api/jobs_api_spec.rb +1 -0
- data/spec/api/repo_syncs_api_spec.rb +2 -0
- data/spec/api/reports_api_spec.rb +2 -2
- data/spec/models/job_update_parameters_spec.rb +0 -6
- metadata +264 -264
data/docs/JobTemplate.md
CHANGED
|
@@ -16,16 +16,16 @@ Name | Type | Description | Notes
|
|
|
16
16
|
## Code Sample
|
|
17
17
|
|
|
18
18
|
```ruby
|
|
19
|
-
require '
|
|
19
|
+
require 'phrase'
|
|
20
20
|
|
|
21
|
-
instance = Phrase::JobTemplate.new(id:
|
|
22
|
-
name:
|
|
23
|
-
briefing:
|
|
24
|
-
project:
|
|
25
|
-
branch:
|
|
26
|
-
autotranslate_enabled:
|
|
27
|
-
created_at:
|
|
28
|
-
updated_at:
|
|
21
|
+
instance = Phrase::JobTemplate.new(id: nil,
|
|
22
|
+
name: nil,
|
|
23
|
+
briefing: nil,
|
|
24
|
+
project: nil,
|
|
25
|
+
branch: nil,
|
|
26
|
+
autotranslate_enabled: nil,
|
|
27
|
+
created_at: nil,
|
|
28
|
+
updated_at: nil)
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
|
|
@@ -14,14 +14,14 @@ Name | Type | Description | Notes
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
16
16
|
```ruby
|
|
17
|
-
require '
|
|
17
|
+
require 'phrase'
|
|
18
18
|
|
|
19
|
-
instance = Phrase::JobTemplateCreateParameters.new(branch: my-feature-branch,
|
|
20
|
-
name: template,
|
|
21
|
-
briefing: text,
|
|
19
|
+
instance = Phrase::JobTemplateCreateParameters.new(branch: 'my-feature-branch',
|
|
20
|
+
name: 'template',
|
|
21
|
+
briefing: 'text',
|
|
22
22
|
autotranslate: true,
|
|
23
|
-
source_locale_id: abcd1234cdef1234abcd1234cdef1234,
|
|
24
|
-
owner_id:
|
|
23
|
+
source_locale_id: 'abcd1234cdef1234abcd1234cdef1234',
|
|
24
|
+
owner_id: nil)
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
|
data/docs/JobTemplateDetails.md
CHANGED
|
@@ -19,19 +19,19 @@ Name | Type | Description | Notes
|
|
|
19
19
|
## Code Sample
|
|
20
20
|
|
|
21
21
|
```ruby
|
|
22
|
-
require '
|
|
22
|
+
require 'phrase'
|
|
23
23
|
|
|
24
|
-
instance = Phrase::JobTemplateDetails.new(id:
|
|
25
|
-
name:
|
|
26
|
-
briefing:
|
|
27
|
-
project:
|
|
28
|
-
branch:
|
|
29
|
-
autotranslate_enabled:
|
|
30
|
-
created_at:
|
|
31
|
-
updated_at:
|
|
32
|
-
owner:
|
|
33
|
-
creator:
|
|
34
|
-
locales:
|
|
24
|
+
instance = Phrase::JobTemplateDetails.new(id: nil,
|
|
25
|
+
name: nil,
|
|
26
|
+
briefing: nil,
|
|
27
|
+
project: nil,
|
|
28
|
+
branch: nil,
|
|
29
|
+
autotranslate_enabled: nil,
|
|
30
|
+
created_at: nil,
|
|
31
|
+
updated_at: nil,
|
|
32
|
+
owner: nil,
|
|
33
|
+
creator: nil,
|
|
34
|
+
locales: nil)
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
|
|
@@ -14,14 +14,14 @@ Name | Type | Description | Notes
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
16
16
|
```ruby
|
|
17
|
-
require '
|
|
17
|
+
require 'phrase'
|
|
18
18
|
|
|
19
|
-
instance = Phrase::JobTemplateLocaleUpdateParameters.new(branch: my-feature-branch,
|
|
20
|
-
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
|
21
|
-
user_ids: [
|
|
22
|
-
reviewer_ids: [
|
|
23
|
-
translator_team_ids: [
|
|
24
|
-
reviewer_team_ids: [
|
|
19
|
+
instance = Phrase::JobTemplateLocaleUpdateParameters.new(branch: 'my-feature-branch',
|
|
20
|
+
locale_id: 'abcd1234cdef1234abcd1234cdef1234',
|
|
21
|
+
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
22
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
23
|
+
translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
24
|
+
reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
|
data/docs/JobTemplateLocales.md
CHANGED
|
@@ -13,13 +13,13 @@ Name | Type | Description | Notes
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
|
15
15
|
```ruby
|
|
16
|
-
require '
|
|
16
|
+
require 'phrase'
|
|
17
17
|
|
|
18
|
-
instance = Phrase::JobTemplateLocales.new(id:
|
|
19
|
-
job_template:
|
|
20
|
-
locale:
|
|
21
|
-
users:
|
|
22
|
-
teams:
|
|
18
|
+
instance = Phrase::JobTemplateLocales.new(id: nil,
|
|
19
|
+
job_template: nil,
|
|
20
|
+
locale: nil,
|
|
21
|
+
users: nil,
|
|
22
|
+
teams: nil)
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
|
|
@@ -14,14 +14,14 @@ Name | Type | Description | Notes
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
16
16
|
```ruby
|
|
17
|
-
require '
|
|
17
|
+
require 'phrase'
|
|
18
18
|
|
|
19
|
-
instance = Phrase::JobTemplateLocalesCreateParameters.new(branch: my-feature-branch,
|
|
20
|
-
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
|
21
|
-
user_ids: [
|
|
22
|
-
reviewer_ids: [
|
|
23
|
-
translator_team_ids: [
|
|
24
|
-
reviewer_team_ids: [
|
|
19
|
+
instance = Phrase::JobTemplateLocalesCreateParameters.new(branch: 'my-feature-branch',
|
|
20
|
+
locale_id: 'abcd1234cdef1234abcd1234cdef1234',
|
|
21
|
+
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
22
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
23
|
+
translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
24
|
+
reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
|
data/docs/JobTemplatePreview.md
CHANGED
|
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'phrase'
|
|
14
14
|
|
|
15
|
-
instance = Phrase::JobTemplatePreview.new(id:
|
|
16
|
-
name:
|
|
15
|
+
instance = Phrase::JobTemplatePreview.new(id: nil,
|
|
16
|
+
name: nil)
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
|
|
@@ -14,14 +14,14 @@ Name | Type | Description | Notes
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
16
16
|
```ruby
|
|
17
|
-
require '
|
|
17
|
+
require 'phrase'
|
|
18
18
|
|
|
19
|
-
instance = Phrase::JobTemplateUpdateParameters.new(branch: my-feature-branch,
|
|
20
|
-
name: template,
|
|
21
|
-
briefing: text,
|
|
19
|
+
instance = Phrase::JobTemplateUpdateParameters.new(branch: 'my-feature-branch',
|
|
20
|
+
name: 'template',
|
|
21
|
+
briefing: 'text',
|
|
22
22
|
autotranslate: true,
|
|
23
|
-
source_locale_id: abcd1234cdef1234abcd1234cdef1234,
|
|
24
|
-
owner_id:
|
|
23
|
+
source_locale_id: 'abcd1234cdef1234abcd1234cdef1234',
|
|
24
|
+
owner_id: nil)
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
|
data/docs/JobUpdateParameters.md
CHANGED
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**branch** | **String** | specify the branch to use | [optional]
|
|
8
7
|
**name** | **String** | Job name | [optional]
|
|
9
8
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
10
9
|
**due_date** | **Time** | Date the job should be finished | [optional]
|
|
@@ -15,14 +14,13 @@ Name | Type | Description | Notes
|
|
|
15
14
|
## Code Sample
|
|
16
15
|
|
|
17
16
|
```ruby
|
|
18
|
-
require '
|
|
17
|
+
require 'phrase'
|
|
19
18
|
|
|
20
|
-
instance = Phrase::JobUpdateParameters.new(
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
target_locale_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
19
|
+
instance = Phrase::JobUpdateParameters.new(name: 'de',
|
|
20
|
+
briefing: 'de-DE',
|
|
21
|
+
due_date: nil,
|
|
22
|
+
ticket_url: 'https://example.atlassian.net/browse/FOO',
|
|
23
|
+
target_locale_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
|
26
24
|
autotranslate: true)
|
|
27
25
|
```
|
|
28
26
|
|
data/docs/JobsApi.md
CHANGED
|
@@ -699,7 +699,8 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
699
699
|
id = 'id_example' # String | ID
|
|
700
700
|
job_update_parameters = Phrase::JobUpdateParameters.new # JobUpdateParameters |
|
|
701
701
|
opts = {
|
|
702
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
702
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
703
|
+
branch: 'my-feature-branch' # String | Branch to use
|
|
703
704
|
}
|
|
704
705
|
|
|
705
706
|
begin
|
|
@@ -720,6 +721,7 @@ Name | Type | Description | Notes
|
|
|
720
721
|
**id** | **String**| ID |
|
|
721
722
|
**job_update_parameters** | [**JobUpdateParameters**](JobUpdateParameters.md)| |
|
|
722
723
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
724
|
+
**branch** | **String**| Branch to use | [optional]
|
|
723
725
|
|
|
724
726
|
### Return type
|
|
725
727
|
|
data/docs/KeyCreateParameters.md
CHANGED
|
@@ -29,29 +29,29 @@ Name | Type | Description | Notes
|
|
|
29
29
|
## Code Sample
|
|
30
30
|
|
|
31
31
|
```ruby
|
|
32
|
-
require '
|
|
32
|
+
require 'phrase'
|
|
33
33
|
|
|
34
|
-
instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
|
|
35
|
-
name: home.index.headline,
|
|
36
|
-
description: Some description worth knowing
|
|
37
|
-
plural:
|
|
38
|
-
use_ordinal_rules:
|
|
39
|
-
name_plural: home.index.headlines,
|
|
40
|
-
data_type: number,
|
|
41
|
-
tags: awesome-feature,needs-proofreading,
|
|
34
|
+
instance = Phrase::KeyCreateParameters.new(branch: 'my-feature-branch',
|
|
35
|
+
name: 'home.index.headline',
|
|
36
|
+
description: 'Some description worth knowing...',
|
|
37
|
+
plural: nil,
|
|
38
|
+
use_ordinal_rules: nil,
|
|
39
|
+
name_plural: 'home.index.headlines',
|
|
40
|
+
data_type: 'number',
|
|
41
|
+
tags: 'awesome-feature,needs-proofreading',
|
|
42
42
|
max_characters_allowed: 140,
|
|
43
|
-
screenshot:
|
|
44
|
-
remove_screenshot:
|
|
45
|
-
unformatted:
|
|
46
|
-
default_translation_content: Default translation content,
|
|
47
|
-
autotranslate:
|
|
48
|
-
xml_space_preserve:
|
|
49
|
-
original_file:
|
|
50
|
-
localized_format_string:
|
|
51
|
-
localized_format_key:
|
|
52
|
-
custom_metadata: {
|
|
53
|
-
excluded_in_locales: [
|
|
54
|
-
format_value_type: string)
|
|
43
|
+
screenshot: File.new('/path/to/file'),
|
|
44
|
+
remove_screenshot: nil,
|
|
45
|
+
unformatted: nil,
|
|
46
|
+
default_translation_content: 'Default translation content',
|
|
47
|
+
autotranslate: nil,
|
|
48
|
+
xml_space_preserve: nil,
|
|
49
|
+
original_file: nil,
|
|
50
|
+
localized_format_string: nil,
|
|
51
|
+
localized_format_key: nil,
|
|
52
|
+
custom_metadata: {"fruit":"Apple","vegetable":"Tomato"},
|
|
53
|
+
excluded_in_locales: ["de","fr"],
|
|
54
|
+
format_value_type: 'string')
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
|
|
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
require '
|
|
13
|
+
require 'phrase'
|
|
14
14
|
|
|
15
|
-
instance = Phrase::KeyFormatAnnotationsList200ResponseInner.new(file_format: xliff_2,
|
|
16
|
-
original_representation:
|
|
15
|
+
instance = Phrase::KeyFormatAnnotationsList200ResponseInner.new(file_format: 'xliff_2',
|
|
16
|
+
original_representation: '<note category="meaning">header</note>')
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
|
data/docs/KeyLink.md
CHANGED
|
@@ -15,15 +15,15 @@ Name | Type | Description | Notes
|
|
|
15
15
|
## Code Sample
|
|
16
16
|
|
|
17
17
|
```ruby
|
|
18
|
-
require '
|
|
18
|
+
require 'phrase'
|
|
19
19
|
|
|
20
|
-
instance = Phrase::KeyLink.new(created_at:
|
|
21
|
-
updated_at:
|
|
22
|
-
created_by:
|
|
23
|
-
updated_by:
|
|
24
|
-
account:
|
|
25
|
-
parent:
|
|
26
|
-
children:
|
|
20
|
+
instance = Phrase::KeyLink.new(created_at: nil,
|
|
21
|
+
updated_at: nil,
|
|
22
|
+
created_by: nil,
|
|
23
|
+
updated_by: nil,
|
|
24
|
+
account: nil,
|
|
25
|
+
parent: nil,
|
|
26
|
+
children: nil)
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
|
|
@@ -11,11 +11,11 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
|
-
require '
|
|
14
|
+
require 'phrase'
|
|
15
15
|
|
|
16
|
-
instance = Phrase::KeyLinksBatchDestroyParameters.new(child_key_ids: [
|
|
17
|
-
unlink_parent:
|
|
18
|
-
strategy:
|
|
16
|
+
instance = Phrase::KeyLinksBatchDestroyParameters.new(child_key_ids: ["feature.subtitle","nav.home"],
|
|
17
|
+
unlink_parent: nil,
|
|
18
|
+
strategy: nil)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|
|
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
|
-
require '
|
|
12
|
+
require 'phrase'
|
|
13
13
|
|
|
14
|
-
instance = Phrase::KeyLinksCreateParameters.new(child_key_ids: [
|
|
14
|
+
instance = Phrase::KeyLinksCreateParameters.new(child_key_ids: ["ijkl9012mnop3456ijkl9012mnop3456","abcd1234efgh5678abcd1234efgh5678"])
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
|
data/docs/KeyPreview.md
CHANGED
|
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
require '
|
|
15
|
+
require 'phrase'
|
|
16
16
|
|
|
17
|
-
instance = Phrase::KeyPreview.new(id:
|
|
18
|
-
name:
|
|
19
|
-
plural:
|
|
20
|
-
use_ordinal_rules:
|
|
17
|
+
instance = Phrase::KeyPreview.new(id: nil,
|
|
18
|
+
name: nil,
|
|
19
|
+
plural: nil,
|
|
20
|
+
use_ordinal_rules: nil)
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
data/docs/KeyUpdateParameters.md
CHANGED
|
@@ -27,27 +27,27 @@ Name | Type | Description | Notes
|
|
|
27
27
|
## Code Sample
|
|
28
28
|
|
|
29
29
|
```ruby
|
|
30
|
-
require '
|
|
30
|
+
require 'phrase'
|
|
31
31
|
|
|
32
|
-
instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
|
|
33
|
-
name: home.index.headline,
|
|
34
|
-
description: Some description worth knowing
|
|
35
|
-
plural:
|
|
36
|
-
use_ordinal_rules:
|
|
37
|
-
name_plural: home.index.headlines,
|
|
38
|
-
data_type: number,
|
|
39
|
-
tags: awesome-feature,needs-proofreading,
|
|
32
|
+
instance = Phrase::KeyUpdateParameters.new(branch: 'my-feature-branch',
|
|
33
|
+
name: 'home.index.headline',
|
|
34
|
+
description: 'Some description worth knowing...',
|
|
35
|
+
plural: nil,
|
|
36
|
+
use_ordinal_rules: nil,
|
|
37
|
+
name_plural: 'home.index.headlines',
|
|
38
|
+
data_type: 'number',
|
|
39
|
+
tags: 'awesome-feature,needs-proofreading',
|
|
40
40
|
max_characters_allowed: 140,
|
|
41
|
-
screenshot:
|
|
42
|
-
remove_screenshot:
|
|
43
|
-
unformatted:
|
|
44
|
-
xml_space_preserve:
|
|
45
|
-
original_file:
|
|
46
|
-
localized_format_string:
|
|
47
|
-
localized_format_key:
|
|
48
|
-
custom_metadata: {
|
|
49
|
-
excluded_in_locales: [
|
|
50
|
-
format_value_type: string)
|
|
41
|
+
screenshot: File.new('/path/to/file'),
|
|
42
|
+
remove_screenshot: nil,
|
|
43
|
+
unformatted: nil,
|
|
44
|
+
xml_space_preserve: nil,
|
|
45
|
+
original_file: nil,
|
|
46
|
+
localized_format_string: nil,
|
|
47
|
+
localized_format_key: nil,
|
|
48
|
+
custom_metadata: {"fruit":"Apple","vegetable":"Tomato"},
|
|
49
|
+
excluded_in_locales: ["de","fr"],
|
|
50
|
+
format_value_type: 'string')
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
|
|
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
require '
|
|
15
|
+
require 'phrase'
|
|
16
16
|
|
|
17
|
-
instance = Phrase::KeysExcludeParameters.new(branch: my-feature-branch,
|
|
18
|
-
q: mykey* translated:true,
|
|
19
|
-
target_locale_id: abcd1234abcd1234abcd1234abcd1234,
|
|
20
|
-
tags: landing-page,release-1.2)
|
|
17
|
+
instance = Phrase::KeysExcludeParameters.new(branch: 'my-feature-branch',
|
|
18
|
+
q: 'mykey* translated:true',
|
|
19
|
+
target_locale_id: 'abcd1234abcd1234abcd1234abcd1234',
|
|
20
|
+
tags: 'landing-page,release-1.2')
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
|
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
require '
|
|
15
|
+
require 'phrase'
|
|
16
16
|
|
|
17
|
-
instance = Phrase::KeysIncludeParameters.new(branch: my-feature-branch,
|
|
18
|
-
q: mykey* translated:true,
|
|
19
|
-
target_locale_id: abcd1234abcd1234abcd1234abcd1234,
|
|
20
|
-
tags: landing-page,release-1.2)
|
|
17
|
+
instance = Phrase::KeysIncludeParameters.new(branch: 'my-feature-branch',
|
|
18
|
+
q: 'mykey* translated:true',
|
|
19
|
+
target_locale_id: 'abcd1234abcd1234abcd1234abcd1234',
|
|
20
|
+
tags: 'landing-page,release-1.2')
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
|
@@ -13,13 +13,13 @@ Name | Type | Description | Notes
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
|
15
15
|
```ruby
|
|
16
|
-
require '
|
|
16
|
+
require 'phrase'
|
|
17
17
|
|
|
18
|
-
instance = Phrase::KeysSearchParameters.new(branch: my-feature-branch,
|
|
19
|
-
sort: updated_at,
|
|
20
|
-
order: desc,
|
|
21
|
-
q: mykey* translated:true,
|
|
22
|
-
locale_id: abcd1234abcd1234abcd1234abcd1234)
|
|
18
|
+
instance = Phrase::KeysSearchParameters.new(branch: 'my-feature-branch',
|
|
19
|
+
sort: 'updated_at',
|
|
20
|
+
order: 'desc',
|
|
21
|
+
q: 'mykey* translated:true',
|
|
22
|
+
locale_id: 'abcd1234abcd1234abcd1234abcd1234')
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
|
data/docs/KeysTagParameters.md
CHANGED
|
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
require '
|
|
15
|
+
require 'phrase'
|
|
16
16
|
|
|
17
|
-
instance = Phrase::KeysTagParameters.new(branch: my-feature-branch,
|
|
18
|
-
q: mykey* translated:true,
|
|
19
|
-
locale_id: abcd1234abcd1234abcd1234abcd1234,
|
|
20
|
-
tags: landing-page,release-1.2)
|
|
17
|
+
instance = Phrase::KeysTagParameters.new(branch: 'my-feature-branch',
|
|
18
|
+
q: 'mykey* translated:true',
|
|
19
|
+
locale_id: 'abcd1234abcd1234abcd1234abcd1234',
|
|
20
|
+
tags: 'landing-page,release-1.2')
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
data/docs/KeysUntagParameters.md
CHANGED
|
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
|
-
require '
|
|
15
|
+
require 'phrase'
|
|
16
16
|
|
|
17
|
-
instance = Phrase::KeysUntagParameters.new(branch: my-feature-branch,
|
|
18
|
-
q: mykey* translated:true,
|
|
19
|
-
locale_id: abcd1234abcd1234abcd1234abcd1234,
|
|
20
|
-
tags: landing-page,release-1.2)
|
|
17
|
+
instance = Phrase::KeysUntagParameters.new(branch: 'my-feature-branch',
|
|
18
|
+
q: 'mykey* translated:true',
|
|
19
|
+
locale_id: 'abcd1234abcd1234abcd1234abcd1234',
|
|
20
|
+
tags: 'landing-page,release-1.2')
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
data/docs/Locale.md
CHANGED
|
@@ -24,24 +24,24 @@ Name | Type | Description | Notes
|
|
|
24
24
|
## Code Sample
|
|
25
25
|
|
|
26
26
|
```ruby
|
|
27
|
-
require '
|
|
27
|
+
require 'phrase'
|
|
28
28
|
|
|
29
|
-
instance = Phrase::Locale.new(id:
|
|
30
|
-
name:
|
|
31
|
-
code:
|
|
32
|
-
default:
|
|
33
|
-
main:
|
|
34
|
-
rtl:
|
|
35
|
-
plural_forms:
|
|
36
|
-
ordinal_plural_forms:
|
|
37
|
-
source_locale:
|
|
38
|
-
fallback_locale:
|
|
39
|
-
language_ai_profile:
|
|
40
|
-
unverify_new_translations:
|
|
41
|
-
unverify_updated_translations:
|
|
42
|
-
unverify_on_source_changes:
|
|
43
|
-
created_at:
|
|
44
|
-
updated_at:
|
|
29
|
+
instance = Phrase::Locale.new(id: nil,
|
|
30
|
+
name: nil,
|
|
31
|
+
code: nil,
|
|
32
|
+
default: nil,
|
|
33
|
+
main: nil,
|
|
34
|
+
rtl: nil,
|
|
35
|
+
plural_forms: nil,
|
|
36
|
+
ordinal_plural_forms: nil,
|
|
37
|
+
source_locale: nil,
|
|
38
|
+
fallback_locale: nil,
|
|
39
|
+
language_ai_profile: nil,
|
|
40
|
+
unverify_new_translations: nil,
|
|
41
|
+
unverify_updated_translations: nil,
|
|
42
|
+
unverify_on_source_changes: nil,
|
|
43
|
+
created_at: nil,
|
|
44
|
+
updated_at: nil)
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
|
-
**name** | **String** | Locale name |
|
|
9
|
-
**code** | **String** | Locale ISO code |
|
|
8
|
+
**name** | **String** | Locale name. Must be unique per project. |
|
|
9
|
+
**code** | **String** | Locale ISO code. Unlike `name`, `code` is not required to be unique per project - creating a locale whose `code` duplicates an existing locale's `code` in the same project will succeed rather than error, resulting in two locales that share the same code. |
|
|
10
10
|
**default** | **Boolean** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional]
|
|
11
11
|
**main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the [Verification System](https://support.phrase.com/hc/en-us/articles/5784094755484) feature. | [optional]
|
|
12
12
|
**rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional]
|
|
@@ -21,21 +21,21 @@ Name | Type | Description | Notes
|
|
|
21
21
|
## Code Sample
|
|
22
22
|
|
|
23
23
|
```ruby
|
|
24
|
-
require '
|
|
24
|
+
require 'phrase'
|
|
25
25
|
|
|
26
|
-
instance = Phrase::LocaleCreateParameters.new(branch: my-feature-branch,
|
|
27
|
-
name: de,
|
|
28
|
-
code: de-DE,
|
|
29
|
-
default:
|
|
30
|
-
main:
|
|
31
|
-
rtl:
|
|
32
|
-
source_locale_id: abcd1234abcd1234abcd1234abcd1234,
|
|
33
|
-
fallback_locale_id: abcd1234abcd1234abcd1234abcd1234,
|
|
34
|
-
unverify_new_translations:
|
|
35
|
-
unverify_updated_translations:
|
|
36
|
-
unverify_on_source_changes:
|
|
37
|
-
autotranslate:
|
|
38
|
-
language_ai_profile: abcd1234abcd1234abcd1234abcd1234)
|
|
26
|
+
instance = Phrase::LocaleCreateParameters.new(branch: 'my-feature-branch',
|
|
27
|
+
name: 'de',
|
|
28
|
+
code: 'de-DE',
|
|
29
|
+
default: nil,
|
|
30
|
+
main: nil,
|
|
31
|
+
rtl: nil,
|
|
32
|
+
source_locale_id: 'abcd1234abcd1234abcd1234abcd1234',
|
|
33
|
+
fallback_locale_id: 'abcd1234abcd1234abcd1234abcd1234',
|
|
34
|
+
unverify_new_translations: nil,
|
|
35
|
+
unverify_updated_translations: nil,
|
|
36
|
+
unverify_on_source_changes: nil,
|
|
37
|
+
autotranslate: nil,
|
|
38
|
+
language_ai_profile: 'abcd1234abcd1234abcd1234abcd1234')
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
|