phrase 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +50 -387
- data/docs/AccountsApi.md +2 -4
- data/docs/AuthorizationsApi.md +10 -14
- data/docs/BitbucketSyncApi.md +3 -6
- data/docs/BlacklistedKeysApi.md +10 -14
- data/docs/BranchesApi.md +12 -18
- data/docs/CommentsApi.md +13 -20
- data/docs/DistributionsApi.md +10 -14
- data/docs/FormatsApi.md +1 -2
- data/docs/GitLabSyncApi.md +7 -14
- data/docs/{GlossaryApi.md → GlossariesApi.md} +26 -30
- data/docs/GlossaryTermTranslationsApi.md +8 -10
- data/docs/GlossaryTermsApi.md +10 -14
- data/docs/InvitationsApi.md +11 -16
- data/docs/JobLocalesApi.md +12 -18
- data/docs/JobsApi.md +15 -24
- data/docs/KeysApi.md +18 -26
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/KeysTagParameters.md +1 -1
- data/docs/KeysUntagParameters.md +1 -1
- data/docs/LocalesApi.md +13 -18
- data/docs/MembersApi.md +4 -8
- data/docs/OrdersApi.md +10 -14
- data/docs/ProjectCreateParameters.md +3 -1
- data/docs/ProjectsApi.md +10 -14
- data/docs/ReleasesApi.md +11 -16
- data/docs/ScreenshotMarkersApi.md +10 -14
- data/docs/ScreenshotsApi.md +10 -14
- data/docs/SpacesApi.md +13 -20
- data/docs/StyleGuidesApi.md +10 -14
- data/docs/TagsApi.md +9 -12
- data/docs/Team.md +29 -0
- data/docs/TeamCreateParameters.md +17 -0
- data/docs/TeamDetail.md +29 -0
- data/docs/TeamUpdateParameters.md +17 -0
- data/docs/TeamsApi.md +721 -0
- data/docs/TeamsProjectsCreateParameters.md +17 -0
- data/docs/TeamsSpacesCreateParameters.md +17 -0
- data/docs/TeamsUsersCreateParameters.md +17 -0
- data/docs/TranslationsApi.md +28 -44
- 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/UploadCreateParameters.md +2 -2
- data/docs/UploadsApi.md +12 -10
- data/docs/UsersApi.md +1 -2
- data/docs/VersionsHistoryApi.md +2 -4
- data/docs/WebhooksApi.md +11 -16
- data/git_push.sh +2 -2
- data/lib/phrase.rb +9 -1
- data/lib/phrase/api/authorizations_api.rb +10 -8
- data/lib/phrase/api/bitbucket_sync_api.rb +3 -3
- data/lib/phrase/api/blacklisted_keys_api.rb +10 -8
- data/lib/phrase/api/branches_api.rb +16 -14
- data/lib/phrase/api/comments_api.rb +19 -17
- data/lib/phrase/api/distributions_api.rb +10 -8
- data/lib/phrase/api/git_lab_sync_api.rb +3 -3
- data/lib/phrase/api/{glossary_api.rb → glossaries_api.rb} +31 -29
- data/lib/phrase/api/glossary_term_translations_api.rb +10 -8
- data/lib/phrase/api/glossary_terms_api.rb +10 -8
- data/lib/phrase/api/invitations_api.rb +10 -8
- data/lib/phrase/api/job_locales_api.rb +10 -8
- data/lib/phrase/api/jobs_api.rb +13 -11
- data/lib/phrase/api/keys_api.rb +14 -12
- data/lib/phrase/api/locales_api.rb +15 -13
- data/lib/phrase/api/members_api.rb +3 -3
- data/lib/phrase/api/orders_api.rb +10 -8
- data/lib/phrase/api/projects_api.rb +10 -8
- data/lib/phrase/api/releases_api.rb +10 -8
- data/lib/phrase/api/screenshot_markers_api.rb +10 -8
- data/lib/phrase/api/screenshots_api.rb +10 -8
- data/lib/phrase/api/spaces_api.rb +16 -14
- data/lib/phrase/api/style_guides_api.rb +10 -8
- data/lib/phrase/api/tags_api.rb +10 -8
- data/lib/phrase/api/teams_api.rb +840 -0
- data/lib/phrase/api/translations_api.rb +13 -11
- data/lib/phrase/api/uploads_api.rb +13 -5
- data/lib/phrase/api/webhooks_api.rb +13 -11
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/keys_tag_parameters.rb +1 -1
- data/lib/phrase/models/keys_untag_parameters.rb +1 -1
- data/lib/phrase/models/project_create_parameters.rb +14 -4
- data/lib/phrase/models/team.rb +254 -0
- data/lib/phrase/models/team_create_parameters.rb +195 -0
- data/lib/phrase/models/team_detail.rb +254 -0
- data/lib/phrase/models/team_update_parameters.rb +195 -0
- data/lib/phrase/models/teams_projects_create_parameters.rb +195 -0
- data/lib/phrase/models/teams_spaces_create_parameters.rb +195 -0
- data/lib/phrase/models/teams_users_create_parameters.rb +195 -0
- 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/models/upload_create_parameters.rb +4 -8
- data/lib/phrase/version.rb +1 -1
- data/spec/api/authorizations_api_spec.rb +1 -1
- data/spec/api/blacklisted_keys_api_spec.rb +1 -1
- data/spec/api/branches_api_spec.rb +1 -1
- data/spec/api/comments_api_spec.rb +1 -1
- data/spec/api/distributions_api_spec.rb +1 -1
- data/spec/api/{glossary_api_spec.rb → glossaries_api_spec.rb} +7 -7
- data/spec/api/glossary_term_translations_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_locales_api_spec.rb +1 -1
- data/spec/api/jobs_api_spec.rb +1 -1
- data/spec/api/keys_api_spec.rb +3 -3
- data/spec/api/locales_api_spec.rb +2 -2
- 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/spaces_api_spec.rb +1 -1
- 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 +185 -0
- data/spec/api/translations_api_spec.rb +4 -4
- data/spec/api/uploads_api_spec.rb +3 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/models/project_create_parameters_spec.rb +6 -0
- data/spec/models/team_create_parameters_spec.rb +29 -0
- data/spec/models/team_detail_spec.rb +65 -0
- data/spec/models/team_spec.rb +65 -0
- data/spec/models/team_update_parameters_spec.rb +29 -0
- data/spec/models/teams_projects_create_parameters_spec.rb +29 -0
- data/spec/models/teams_spaces_create_parameters_spec.rb +29 -0
- data/spec/models/teams_users_create_parameters_spec.rb +29 -0
- metadata +183 -151
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Phrase::TeamsProjectsCreateParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | Project ID to add to the Team | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Phrase'
|
|
13
|
+
|
|
14
|
+
instance = Phrase::TeamsProjectsCreateParameters.new(id: a4b3c2d1)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Phrase::TeamsSpacesCreateParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | Space ID to add to the Team | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Phrase'
|
|
13
|
+
|
|
14
|
+
instance = Phrase::TeamsSpacesCreateParameters.new(id: a4b3c2d1)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Phrase::TeamsUsersCreateParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | User ID to add to the Team | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Phrase'
|
|
13
|
+
|
|
14
|
+
instance = Phrase::TeamsUsersCreateParameters.new(id: a4b3c2d1)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/TranslationsApi.md
CHANGED
|
@@ -26,7 +26,7 @@ Method | HTTP request | Description
|
|
|
26
26
|
|
|
27
27
|
## translation_create
|
|
28
28
|
|
|
29
|
-
> translation_create(project_id, translation_create_parameters, opts)
|
|
29
|
+
> TranslationDetails translation_create(project_id, translation_create_parameters, opts)
|
|
30
30
|
|
|
31
31
|
Create a translation
|
|
32
32
|
|
|
@@ -45,8 +45,7 @@ Phrase.configure do |config|
|
|
|
45
45
|
|
|
46
46
|
# Configure API key authorization: Token
|
|
47
47
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
48
|
-
|
|
49
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
48
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
50
49
|
end
|
|
51
50
|
|
|
52
51
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -58,7 +57,8 @@ opts = {
|
|
|
58
57
|
|
|
59
58
|
begin
|
|
60
59
|
#Create a translation
|
|
61
|
-
api_instance.translation_create(project_id, translation_create_parameters, opts)
|
|
60
|
+
result = api_instance.translation_create(project_id, translation_create_parameters, opts)
|
|
61
|
+
pp result
|
|
62
62
|
rescue Phrase::ApiError => e
|
|
63
63
|
puts "Exception when calling TranslationsApi->translation_create: #{e}"
|
|
64
64
|
end
|
|
@@ -75,7 +75,7 @@ Name | Type | Description | Notes
|
|
|
75
75
|
|
|
76
76
|
### Return type
|
|
77
77
|
|
|
78
|
-
Response<(
|
|
78
|
+
Response<([**TranslationDetails**](TranslationDetails.md))>
|
|
79
79
|
|
|
80
80
|
### Authorization
|
|
81
81
|
|
|
@@ -84,7 +84,7 @@ Response<(nil (empty response body))>
|
|
|
84
84
|
### HTTP request headers
|
|
85
85
|
|
|
86
86
|
- **Content-Type**: application/json
|
|
87
|
-
- **Accept**:
|
|
87
|
+
- **Accept**: application/json
|
|
88
88
|
|
|
89
89
|
|
|
90
90
|
## translation_exclude
|
|
@@ -108,8 +108,7 @@ Phrase.configure do |config|
|
|
|
108
108
|
|
|
109
109
|
# Configure API key authorization: Token
|
|
110
110
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
111
|
-
|
|
112
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
111
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
113
112
|
end
|
|
114
113
|
|
|
115
114
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -174,8 +173,7 @@ Phrase.configure do |config|
|
|
|
174
173
|
|
|
175
174
|
# Configure API key authorization: Token
|
|
176
175
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
177
|
-
|
|
178
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
176
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
179
177
|
end
|
|
180
178
|
|
|
181
179
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -240,8 +238,7 @@ Phrase.configure do |config|
|
|
|
240
238
|
|
|
241
239
|
# Configure API key authorization: Token
|
|
242
240
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
243
|
-
|
|
244
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
241
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
245
242
|
end
|
|
246
243
|
|
|
247
244
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -306,8 +303,7 @@ Phrase.configure do |config|
|
|
|
306
303
|
|
|
307
304
|
# Configure API key authorization: Token
|
|
308
305
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
309
|
-
|
|
310
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
306
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
311
307
|
end
|
|
312
308
|
|
|
313
309
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -372,8 +368,7 @@ Phrase.configure do |config|
|
|
|
372
368
|
|
|
373
369
|
# Configure API key authorization: Token
|
|
374
370
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
375
|
-
|
|
376
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
371
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
377
372
|
end
|
|
378
373
|
|
|
379
374
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -438,8 +433,7 @@ Phrase.configure do |config|
|
|
|
438
433
|
|
|
439
434
|
# Configure API key authorization: Token
|
|
440
435
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
441
|
-
|
|
442
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
436
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
443
437
|
end
|
|
444
438
|
|
|
445
439
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -504,8 +498,7 @@ Phrase.configure do |config|
|
|
|
504
498
|
|
|
505
499
|
# Configure API key authorization: Token
|
|
506
500
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
507
|
-
|
|
508
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
501
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
509
502
|
end
|
|
510
503
|
|
|
511
504
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -570,8 +563,7 @@ Phrase.configure do |config|
|
|
|
570
563
|
|
|
571
564
|
# Configure API key authorization: Token
|
|
572
565
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
573
|
-
|
|
574
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
566
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
575
567
|
end
|
|
576
568
|
|
|
577
569
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -584,7 +576,7 @@ opts = {
|
|
|
584
576
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
585
577
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
586
578
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
587
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String |
|
|
579
|
+
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>.
|
|
588
580
|
}
|
|
589
581
|
|
|
590
582
|
begin
|
|
@@ -609,7 +601,7 @@ Name | Type | Description | Notes
|
|
|
609
601
|
**branch** | **String**| specify the branch to use | [optional]
|
|
610
602
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
611
603
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
612
|
-
**q** | **String**|
|
|
604
|
+
**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]
|
|
613
605
|
|
|
614
606
|
### Return type
|
|
615
607
|
|
|
@@ -646,8 +638,7 @@ Phrase.configure do |config|
|
|
|
646
638
|
|
|
647
639
|
# Configure API key authorization: Token
|
|
648
640
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
649
|
-
|
|
650
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
641
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
651
642
|
end
|
|
652
643
|
|
|
653
644
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -660,7 +651,7 @@ opts = {
|
|
|
660
651
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
661
652
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
662
653
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
663
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String |
|
|
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>.
|
|
664
655
|
}
|
|
665
656
|
|
|
666
657
|
begin
|
|
@@ -685,7 +676,7 @@ Name | Type | Description | Notes
|
|
|
685
676
|
**branch** | **String**| specify the branch to use | [optional]
|
|
686
677
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
687
678
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
688
|
-
**q** | **String**|
|
|
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]
|
|
689
680
|
|
|
690
681
|
### Return type
|
|
691
682
|
|
|
@@ -722,8 +713,7 @@ Phrase.configure do |config|
|
|
|
722
713
|
|
|
723
714
|
# Configure API key authorization: Token
|
|
724
715
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
725
|
-
|
|
726
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
716
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
727
717
|
end
|
|
728
718
|
|
|
729
719
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -786,8 +776,7 @@ Phrase.configure do |config|
|
|
|
786
776
|
|
|
787
777
|
# Configure API key authorization: Token
|
|
788
778
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
789
|
-
|
|
790
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
779
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
791
780
|
end
|
|
792
781
|
|
|
793
782
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -850,8 +839,7 @@ Phrase.configure do |config|
|
|
|
850
839
|
|
|
851
840
|
# Configure API key authorization: Token
|
|
852
841
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
853
|
-
|
|
854
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
842
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
855
843
|
end
|
|
856
844
|
|
|
857
845
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -863,7 +851,7 @@ opts = {
|
|
|
863
851
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
864
852
|
sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
|
|
865
853
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
866
|
-
q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String |
|
|
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>.
|
|
867
855
|
}
|
|
868
856
|
|
|
869
857
|
begin
|
|
@@ -887,7 +875,7 @@ Name | Type | Description | Notes
|
|
|
887
875
|
**branch** | **String**| specify the branch to use | [optional]
|
|
888
876
|
**sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
889
877
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
890
|
-
**q** | **String**|
|
|
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]
|
|
891
879
|
|
|
892
880
|
### Return type
|
|
893
881
|
|
|
@@ -924,8 +912,7 @@ Phrase.configure do |config|
|
|
|
924
912
|
|
|
925
913
|
# Configure API key authorization: Token
|
|
926
914
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
927
|
-
|
|
928
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
915
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
929
916
|
end
|
|
930
917
|
|
|
931
918
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -988,8 +975,7 @@ Phrase.configure do |config|
|
|
|
988
975
|
|
|
989
976
|
# Configure API key authorization: Token
|
|
990
977
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
991
|
-
|
|
992
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
978
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
993
979
|
end
|
|
994
980
|
|
|
995
981
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -1056,8 +1042,7 @@ Phrase.configure do |config|
|
|
|
1056
1042
|
|
|
1057
1043
|
# Configure API key authorization: Token
|
|
1058
1044
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1059
|
-
|
|
1060
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1045
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
1061
1046
|
end
|
|
1062
1047
|
|
|
1063
1048
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -1120,8 +1105,7 @@ Phrase.configure do |config|
|
|
|
1120
1105
|
|
|
1121
1106
|
# Configure API key authorization: Token
|
|
1122
1107
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1123
|
-
|
|
1124
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1108
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
1125
1109
|
end
|
|
1126
1110
|
|
|
1127
1111
|
api_instance = Phrase::TranslationsApi.new
|
|
@@ -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** |
|
|
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]
|
|
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** |
|
|
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]
|
|
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** |
|
|
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]
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
|
8
8
|
**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
|
|
9
9
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
|
10
|
-
**q** | **String** |
|
|
10
|
+
**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]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -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** |
|
|
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]
|
|
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** |
|
|
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]
|
|
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
|
|
|
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**skip_upload_tags** | **Boolean** | Indicates whether the upload should not create upload tags. | [optional]
|
|
16
16
|
**skip_unverification** | **Boolean** | Indicates whether the upload should unverify updated translations. | [optional]
|
|
17
17
|
**file_encoding** | **String** | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | [optional]
|
|
18
|
-
**locale_mapping** | **
|
|
19
|
-
**format_options** | **
|
|
18
|
+
**locale_mapping** | [**Object**](.md) | Optional, format specific mapping between locale names and the columns the translations to those locales are contained in. | [optional]
|
|
19
|
+
**format_options** | [**Object**](.md) | Additional options available for specific formats. See our format guide for complete list. | [optional]
|
|
20
20
|
**autotranslate** | **Boolean** | If set, translations for the uploaded language will be fetched automatically. | [optional]
|
|
21
21
|
**mark_reviewed** | **Boolean** | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project. | [optional]
|
|
22
22
|
|
data/docs/UploadsApi.md
CHANGED
|
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
|
12
12
|
|
|
13
13
|
## upload_create
|
|
14
14
|
|
|
15
|
-
> upload_create(project_id, opts)
|
|
15
|
+
> Upload upload_create(project_id, opts)
|
|
16
16
|
|
|
17
17
|
Upload a new file
|
|
18
18
|
|
|
@@ -31,8 +31,7 @@ Phrase.configure do |config|
|
|
|
31
31
|
|
|
32
32
|
# Configure API key authorization: Token
|
|
33
33
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
34
|
-
|
|
35
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
34
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
36
35
|
end
|
|
37
36
|
|
|
38
37
|
api_instance = Phrase::UploadsApi.new
|
|
@@ -50,13 +49,16 @@ opts = {
|
|
|
50
49
|
skip_upload_tags: true, # Boolean | Indicates whether the upload should not create upload tags.
|
|
51
50
|
skip_unverification: true, # Boolean | Indicates whether the upload should unverify updated translations.
|
|
52
51
|
file_encoding: 'file_encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\".
|
|
52
|
+
locale_mapping: nil, # Object | Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.
|
|
53
|
+
format_options: nil, # Object | Additional options available for specific formats. See our format guide for complete list.
|
|
53
54
|
autotranslate: true, # Boolean | If set, translations for the uploaded language will be fetched automatically.
|
|
54
55
|
mark_reviewed: true # Boolean | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project.
|
|
55
56
|
}
|
|
56
57
|
|
|
57
58
|
begin
|
|
58
59
|
#Upload a new file
|
|
59
|
-
api_instance.upload_create(project_id, opts)
|
|
60
|
+
result = api_instance.upload_create(project_id, opts)
|
|
61
|
+
pp result
|
|
60
62
|
rescue Phrase::ApiError => e
|
|
61
63
|
puts "Exception when calling UploadsApi->upload_create: #{e}"
|
|
62
64
|
end
|
|
@@ -80,12 +82,14 @@ Name | Type | Description | Notes
|
|
|
80
82
|
**skip_upload_tags** | **Boolean**| Indicates whether the upload should not create upload tags. | [optional]
|
|
81
83
|
**skip_unverification** | **Boolean**| Indicates whether the upload should unverify updated translations. | [optional]
|
|
82
84
|
**file_encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\". | [optional]
|
|
85
|
+
**locale_mapping** | [**Object**](Object.md)| Optional, format specific mapping between locale names and the columns the translations to those locales are contained in. | [optional]
|
|
86
|
+
**format_options** | [**Object**](Object.md)| Additional options available for specific formats. See our format guide for complete list. | [optional]
|
|
83
87
|
**autotranslate** | **Boolean**| If set, translations for the uploaded language will be fetched automatically. | [optional]
|
|
84
88
|
**mark_reviewed** | **Boolean**| Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project. | [optional]
|
|
85
89
|
|
|
86
90
|
### Return type
|
|
87
91
|
|
|
88
|
-
Response<(
|
|
92
|
+
Response<([**Upload**](Upload.md))>
|
|
89
93
|
|
|
90
94
|
### Authorization
|
|
91
95
|
|
|
@@ -94,7 +98,7 @@ Response<(nil (empty response body))>
|
|
|
94
98
|
### HTTP request headers
|
|
95
99
|
|
|
96
100
|
- **Content-Type**: multipart/form-data
|
|
97
|
-
- **Accept**:
|
|
101
|
+
- **Accept**: application/json
|
|
98
102
|
|
|
99
103
|
|
|
100
104
|
## upload_show
|
|
@@ -118,8 +122,7 @@ Phrase.configure do |config|
|
|
|
118
122
|
|
|
119
123
|
# Configure API key authorization: Token
|
|
120
124
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
121
|
-
|
|
122
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
125
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
123
126
|
end
|
|
124
127
|
|
|
125
128
|
api_instance = Phrase::UploadsApi.new
|
|
@@ -184,8 +187,7 @@ Phrase.configure do |config|
|
|
|
184
187
|
|
|
185
188
|
# Configure API key authorization: Token
|
|
186
189
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
187
|
-
|
|
188
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
190
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
189
191
|
end
|
|
190
192
|
|
|
191
193
|
api_instance = Phrase::UploadsApi.new
|