phrase 3.2.1 → 3.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +10 -5
- data/docs/KeyCreateParameters.md +1 -1
- data/docs/KeyUpdateParameters.md +1 -1
- data/docs/LocaleDownload.md +29 -0
- data/docs/LocaleDownloadCreateParameters.md +43 -0
- data/docs/LocaleDownloadParams.md +29 -0
- data/docs/LocaleDownloadResult.md +17 -0
- data/docs/LocaleDownloadsApi.md +148 -0
- data/docs/ProjectCreateParameters.md +1 -1
- data/docs/ProjectUpdateParameters.md +1 -1
- data/docs/RepoSyncEvent.md +3 -1
- data/docs/RepoSyncsApi.md +70 -4
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/lib/phrase/api/locale_downloads_api.rb +180 -0
- data/lib/phrase/api/repo_syncs_api.rb +84 -6
- data/lib/phrase/models/locale_download.rb +285 -0
- data/lib/phrase/models/locale_download_create_parameters.rb +332 -0
- data/lib/phrase/models/{repo_sync_import.rb → locale_download_params.rb} +65 -10
- data/lib/phrase/models/{repo_sync_export.rb → locale_download_result.rb} +11 -10
- data/lib/phrase/models/repo_sync_event.rb +10 -1
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +5 -2
- data/spec/api/locale_downloads_api_spec.rb +57 -0
- data/spec/api/repo_syncs_api_spec.rb +17 -2
- data/spec/models/locale_download_create_parameters_spec.rb +107 -0
- data/spec/models/locale_download_params_spec.rb +65 -0
- data/spec/models/{repo_sync_export_spec.rb → locale_download_result_spec.rb} +7 -7
- data/spec/models/locale_download_spec.rb +69 -0
- data/spec/models/repo_sync_event_spec.rb +6 -0
- metadata +258 -246
- data/docs/RepoSyncExport.md +0 -17
- data/docs/RepoSyncImport.md +0 -17
- data/spec/models/repo_sync_import_spec.rb +0 -29
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b0c0e316a5bcde1e1e02bc9e11abbbabc389113de2861b629056ca556f9734a2
|
4
|
+
data.tar.gz: e0e1ba900387b099debdfac4e8c56b778f77d4ff8362b3cc2482f8638233b254
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7a36bf608806decc7daa0ed8105c7ec2a7a423b7a47a6fa0c492aa9af3591268a38511fd0ef06f047572211d270f1bd0d8eeed422f4cec8cab73e11c0e370602
|
7
|
+
data.tar.gz: e35ebae6a19d4b32403cec92fae34cd0afc6964bb13182ccdf063ec9ba134b0eb6488d4283406e165162cf66bfc532c1d2e0b9d6c7b84c864b0528fb79752563
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [3.3.0](https://github.com/phrase/openapi/compare/ruby-v3.2.1...ruby-v3.3.0) (2024-07-02)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* add repo sync events show endpoint ([#641](https://github.com/phrase/openapi/issues/641)) ([e1d9cfb](https://github.com/phrase/openapi/commit/e1d9cfb23e079fea2d9e5475dff9a4137f1f0154))
|
9
|
+
* **API:** Async downloads [TSI-2515] ([#642](https://github.com/phrase/openapi/issues/642)) ([6fcab5d](https://github.com/phrase/openapi/commit/6fcab5d4719f64e8e5dd49c327dc9348b384de4c))
|
10
|
+
|
3
11
|
## [3.2.1](https://github.com/phrase/openapi/compare/ruby-v3.2.0...ruby-v3.2.1) (2024-06-18)
|
4
12
|
|
5
13
|
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
|
|
7
7
|
## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.
|
10
|
+
- Package version: 3.3.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
|
13
13
|
|
@@ -56,10 +56,10 @@ gem build phrase.gemspec
|
|
56
56
|
Then install the gem locally:
|
57
57
|
|
58
58
|
```shell
|
59
|
-
gem install ./phrase-3.
|
59
|
+
gem install ./phrase-3.3.0.gem
|
60
60
|
```
|
61
61
|
|
62
|
-
(for development, run `gem install --dev ./phrase-3.
|
62
|
+
(for development, run `gem install --dev ./phrase-3.3.0.gem` to install the development dependencies)
|
63
63
|
|
64
64
|
## Getting Started
|
65
65
|
|
@@ -271,6 +271,8 @@ Class | Method | HTTP request | Description
|
|
271
271
|
*Phrase::LinkedKeysApi* | [**key_links_create**](docs/LinkedKeysApi.md#key_links_create) | **POST** /projects/{project_id}/keys/{id}/key_links | Link child keys to a parent key
|
272
272
|
*Phrase::LinkedKeysApi* | [**key_links_destroy**](docs/LinkedKeysApi.md#key_links_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links/{child_key_id} | Unlink a child key from a parent key
|
273
273
|
*Phrase::LinkedKeysApi* | [**key_links_index**](docs/LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | List child keys of a parent key
|
274
|
+
*Phrase::LocaleDownloadsApi* | [**locale_download_create**](docs/LocaleDownloadsApi.md#locale_download_create) | **POST** /projects/{project_id}/locales/{locale_id}/downloads | Initiate async download of a locale
|
275
|
+
*Phrase::LocaleDownloadsApi* | [**locale_download_show**](docs/LocaleDownloadsApi.md#locale_download_show) | **GET** /projects/{project_id}/locales/{locale_id}/downloads/{id} | Show status of an async locale download
|
274
276
|
*Phrase::LocalesApi* | [**account_locales**](docs/LocalesApi.md#account_locales) | **GET** /accounts/{id}/locales | List locales used in account
|
275
277
|
*Phrase::LocalesApi* | [**locale_create**](docs/LocalesApi.md#locale_create) | **POST** /projects/{project_id}/locales | Create a locale
|
276
278
|
*Phrase::LocalesApi* | [**locale_delete**](docs/LocalesApi.md#locale_delete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale
|
@@ -323,6 +325,7 @@ Class | Method | HTTP request | Description
|
|
323
325
|
*Phrase::ReleasesApi* | [**releases_list**](docs/ReleasesApi.md#releases_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases | List releases
|
324
326
|
*Phrase::RepoSyncsApi* | [**repo_sync_activate**](docs/RepoSyncsApi.md#repo_sync_activate) | **POST** /accounts/{account_id}/repo_syncs/{id}/activate | Activate a Repo Sync
|
325
327
|
*Phrase::RepoSyncsApi* | [**repo_sync_deactivate**](docs/RepoSyncsApi.md#repo_sync_deactivate) | **POST** /accounts/{account_id}/repo_syncs/{id}/deactivate | Deactivate a Repo Sync
|
328
|
+
*Phrase::RepoSyncsApi* | [**repo_sync_event_show**](docs/RepoSyncsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event
|
326
329
|
*Phrase::RepoSyncsApi* | [**repo_sync_events**](docs/RepoSyncsApi.md#repo_sync_events) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History
|
327
330
|
*Phrase::RepoSyncsApi* | [**repo_sync_export**](docs/RepoSyncsApi.md#repo_sync_export) | **POST** /accounts/{account_id}/repo_syncs/{id}/export | Export to code repository
|
328
331
|
*Phrase::RepoSyncsApi* | [**repo_sync_import**](docs/RepoSyncsApi.md#repo_sync_import) | **POST** /accounts/{account_id}/repo_syncs/{id}/import | Import from code repository
|
@@ -519,6 +522,10 @@ Class | Method | HTTP request | Description
|
|
519
522
|
- [Phrase::Locale](docs/Locale.md)
|
520
523
|
- [Phrase::LocaleCreateParameters](docs/LocaleCreateParameters.md)
|
521
524
|
- [Phrase::LocaleDetails](docs/LocaleDetails.md)
|
525
|
+
- [Phrase::LocaleDownload](docs/LocaleDownload.md)
|
526
|
+
- [Phrase::LocaleDownloadCreateParameters](docs/LocaleDownloadCreateParameters.md)
|
527
|
+
- [Phrase::LocaleDownloadParams](docs/LocaleDownloadParams.md)
|
528
|
+
- [Phrase::LocaleDownloadResult](docs/LocaleDownloadResult.md)
|
522
529
|
- [Phrase::LocalePreview](docs/LocalePreview.md)
|
523
530
|
- [Phrase::LocalePreview1](docs/LocalePreview1.md)
|
524
531
|
- [Phrase::LocaleReport](docs/LocaleReport.md)
|
@@ -567,8 +574,6 @@ Class | Method | HTTP request | Description
|
|
567
574
|
- [Phrase::RepoSync](docs/RepoSync.md)
|
568
575
|
- [Phrase::RepoSyncEvent](docs/RepoSyncEvent.md)
|
569
576
|
- [Phrase::RepoSyncEventErrorsInner](docs/RepoSyncEventErrorsInner.md)
|
570
|
-
- [Phrase::RepoSyncExport](docs/RepoSyncExport.md)
|
571
|
-
- [Phrase::RepoSyncImport](docs/RepoSyncImport.md)
|
572
577
|
- [Phrase::Screenshot](docs/Screenshot.md)
|
573
578
|
- [Phrase::ScreenshotMarker](docs/ScreenshotMarker.md)
|
574
579
|
- [Phrase::ScreenshotMarkerCreateParameters](docs/ScreenshotMarkerCreateParameters.md)
|
data/docs/KeyCreateParameters.md
CHANGED
@@ -35,7 +35,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
|
|
35
35
|
data_type: number,
|
36
36
|
tags: awesome-feature,needs-proofreading,
|
37
37
|
max_characters_allowed: 140,
|
38
|
-
screenshot: [B@
|
38
|
+
screenshot: [B@4ee127c6,
|
39
39
|
remove_screenshot: null,
|
40
40
|
unformatted: null,
|
41
41
|
default_translation_content: Default translation content,
|
data/docs/KeyUpdateParameters.md
CHANGED
@@ -34,7 +34,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
|
|
34
34
|
data_type: number,
|
35
35
|
tags: awesome-feature,needs-proofreading,
|
36
36
|
max_characters_allowed: 140,
|
37
|
-
screenshot: [B@
|
37
|
+
screenshot: [B@5e805a0d,
|
38
38
|
remove_screenshot: null,
|
39
39
|
unformatted: null,
|
40
40
|
xml_space_preserve: null,
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# Phrase::LocaleDownload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**status** | **String** | The status of the download request. Possible values are `processing`, `completed`, and `error`. | [optional]
|
9
|
+
**result** | [**LocaleDownloadResult**](LocaleDownloadResult.md) | | [optional]
|
10
|
+
**params** | [**LocaleDownloadParams**](LocaleDownloadParams.md) | | [optional]
|
11
|
+
**error** | **String** | | [optional]
|
12
|
+
**created_at** | **Time** | | [optional]
|
13
|
+
**completed_at** | **Time** | | [optional]
|
14
|
+
|
15
|
+
## Code Sample
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'Phrase'
|
19
|
+
|
20
|
+
instance = Phrase::LocaleDownload.new(id: null,
|
21
|
+
status: null,
|
22
|
+
result: null,
|
23
|
+
params: null,
|
24
|
+
error: null,
|
25
|
+
created_at: null,
|
26
|
+
completed_at: null)
|
27
|
+
```
|
28
|
+
|
29
|
+
|
@@ -0,0 +1,43 @@
|
|
1
|
+
# Phrase::LocaleDownloadCreateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**file_format** | **String** | File format name. See the <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for all supported file formats. |
|
8
|
+
**branch** | **String** | specify the branch to use | [optional]
|
9
|
+
**tags** | **String** | Limit results to keys tagged with a list of comma separated tag names. | [optional]
|
10
|
+
**include_empty_translations** | **Boolean** | Indicates whether keys without translations should be included in the output as well. | [optional]
|
11
|
+
**exclude_empty_zero_forms** | **Boolean** | Indicates whether zero forms should be included when empty in pluralized keys. | [optional]
|
12
|
+
**include_translated_keys** | **Boolean** | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional]
|
13
|
+
**keep_notranslate_tags** | **Boolean** | Indicates whether [NOTRANSLATE] tags should be kept. | [optional]
|
14
|
+
**format_options** | **Object** | Additional formatting and render options. See the <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code> | [optional]
|
15
|
+
**encoding** | **String** | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | [optional]
|
16
|
+
**include_unverified_translations** | **Boolean** | if set to false unverified translations are excluded | [optional]
|
17
|
+
**use_last_reviewed_version** | **Boolean** | If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | [optional]
|
18
|
+
**fallback_locale_id** | **String** | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>. | [optional]
|
19
|
+
**source_locale_id** | **String** | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job. | [optional]
|
20
|
+
**custom_metadata_filters** | **Object** | Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. | [optional]
|
21
|
+
|
22
|
+
## Code Sample
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'Phrase'
|
26
|
+
|
27
|
+
instance = Phrase::LocaleDownloadCreateParameters.new(file_format: yml,
|
28
|
+
branch: my-feature-branch,
|
29
|
+
tags: feature1,feature2,
|
30
|
+
include_empty_translations: true,
|
31
|
+
exclude_empty_zero_forms: true,
|
32
|
+
include_translated_keys: true,
|
33
|
+
keep_notranslate_tags: true,
|
34
|
+
format_options: null,
|
35
|
+
encoding: UTF-8,
|
36
|
+
include_unverified_translations: true,
|
37
|
+
use_last_reviewed_version: null,
|
38
|
+
fallback_locale_id: abcd1234abcd1234abcd1234abcd1234,
|
39
|
+
source_locale_id: abcd1234abcd1234abcd1234abcd1234,
|
40
|
+
custom_metadata_filters: null)
|
41
|
+
```
|
42
|
+
|
43
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# Phrase::LocaleDownloadParams
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**file_format** | **String** | | [optional]
|
8
|
+
**locale_id** | **String** | | [optional]
|
9
|
+
**tags** | **String** | | [optional]
|
10
|
+
**branch** | **String** | | [optional]
|
11
|
+
**include_empty_translations** | **Boolean** | | [optional]
|
12
|
+
**include_translated_keys** | **Boolean** | | [optional]
|
13
|
+
**include_unverified_translations** | **Boolean** | | [optional]
|
14
|
+
|
15
|
+
## Code Sample
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'Phrase'
|
19
|
+
|
20
|
+
instance = Phrase::LocaleDownloadParams.new(file_format: null,
|
21
|
+
locale_id: null,
|
22
|
+
tags: null,
|
23
|
+
branch: null,
|
24
|
+
include_empty_translations: null,
|
25
|
+
include_translated_keys: null,
|
26
|
+
include_unverified_translations: null)
|
27
|
+
```
|
28
|
+
|
29
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Phrase::LocaleDownloadResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**url** | **String** | The URL to the download file. This URL is valid for 15 minutes. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'Phrase'
|
13
|
+
|
14
|
+
instance = Phrase::LocaleDownloadResult.new(url: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,148 @@
|
|
1
|
+
# Phrase::LocaleDownloadsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**locale_download_create**](LocaleDownloadsApi.md#locale_download_create) | **POST** /projects/{project_id}/locales/{locale_id}/downloads | Initiate async download of a locale
|
8
|
+
[**locale_download_show**](LocaleDownloadsApi.md#locale_download_show) | **GET** /projects/{project_id}/locales/{locale_id}/downloads/{id} | Show status of an async locale download
|
9
|
+
|
10
|
+
|
11
|
+
|
12
|
+
## locale_download_create
|
13
|
+
|
14
|
+
> LocaleDownload locale_download_create(project_id, locale_id, locale_download_create_parameters, opts)
|
15
|
+
|
16
|
+
Initiate async download of a locale
|
17
|
+
|
18
|
+
Prepare a locale for download in a specific file format.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'phrase'
|
25
|
+
# setup authorization
|
26
|
+
Phrase.configure do |config|
|
27
|
+
# Configure HTTP basic authorization: Basic
|
28
|
+
config.username = 'YOUR USERNAME'
|
29
|
+
config.password = 'YOUR PASSWORD'
|
30
|
+
|
31
|
+
# Configure API key authorization: Token
|
32
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
33
|
+
config.api_key_prefix['Authorization'] = 'token'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = Phrase::LocaleDownloadsApi.new
|
37
|
+
project_id = 'project_id_example' # String | Project ID
|
38
|
+
locale_id = 'locale_id_example' # String | Locale ID
|
39
|
+
locale_download_create_parameters = Phrase::LocaleDownloadCreateParameters.new({file_format: 'yml'}) # LocaleDownloadCreateParameters |
|
40
|
+
opts = {
|
41
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
42
|
+
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
43
|
+
if_none_match: 'if_none_match_example' # String | ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
44
|
+
}
|
45
|
+
|
46
|
+
begin
|
47
|
+
#Initiate async download of a locale
|
48
|
+
result = api_instance.locale_download_create(project_id, locale_id, locale_download_create_parameters, opts)
|
49
|
+
pp result
|
50
|
+
rescue Phrase::ApiError => e
|
51
|
+
puts "Exception when calling LocaleDownloadsApi->locale_download_create: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**project_id** | **String**| Project ID |
|
61
|
+
**locale_id** | **String**| Locale ID |
|
62
|
+
**locale_download_create_parameters** | [**LocaleDownloadCreateParameters**](LocaleDownloadCreateParameters.md)| |
|
63
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
64
|
+
**if_modified_since** | **String**| Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
65
|
+
**if_none_match** | **String**| ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
Response<([**LocaleDownload**](LocaleDownload.md))>
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: application/json
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
80
|
+
|
81
|
+
## locale_download_show
|
82
|
+
|
83
|
+
> LocaleDownload locale_download_show(project_id, locale_id, id, opts)
|
84
|
+
|
85
|
+
Show status of an async locale download
|
86
|
+
|
87
|
+
Show status of already started async locale download. If the download is finished, the download link will be returned.
|
88
|
+
|
89
|
+
### Example
|
90
|
+
|
91
|
+
```ruby
|
92
|
+
# load the gem
|
93
|
+
require 'phrase'
|
94
|
+
# setup authorization
|
95
|
+
Phrase.configure do |config|
|
96
|
+
# Configure HTTP basic authorization: Basic
|
97
|
+
config.username = 'YOUR USERNAME'
|
98
|
+
config.password = 'YOUR PASSWORD'
|
99
|
+
|
100
|
+
# Configure API key authorization: Token
|
101
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
102
|
+
config.api_key_prefix['Authorization'] = 'token'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = Phrase::LocaleDownloadsApi.new
|
106
|
+
project_id = 'project_id_example' # String | Project ID
|
107
|
+
locale_id = 'locale_id_example' # String | Locale ID
|
108
|
+
id = 'id_example' # String | ID
|
109
|
+
opts = {
|
110
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
111
|
+
if_modified_since: 'if_modified_since_example', # String | Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
112
|
+
if_none_match: 'if_none_match_example' # String | ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
|
113
|
+
}
|
114
|
+
|
115
|
+
begin
|
116
|
+
#Show status of an async locale download
|
117
|
+
result = api_instance.locale_download_show(project_id, locale_id, id, opts)
|
118
|
+
pp result
|
119
|
+
rescue Phrase::ApiError => e
|
120
|
+
puts "Exception when calling LocaleDownloadsApi->locale_download_show: #{e}"
|
121
|
+
end
|
122
|
+
```
|
123
|
+
|
124
|
+
### Parameters
|
125
|
+
|
126
|
+
|
127
|
+
Name | Type | Description | Notes
|
128
|
+
------------- | ------------- | ------------- | -------------
|
129
|
+
**project_id** | **String**| Project ID |
|
130
|
+
**locale_id** | **String**| Locale ID |
|
131
|
+
**id** | **String**| ID |
|
132
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
133
|
+
**if_modified_since** | **String**| Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
134
|
+
**if_none_match** | **String**| ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
135
|
+
|
136
|
+
### Return type
|
137
|
+
|
138
|
+
Response<([**LocaleDownload**](LocaleDownload.md))>
|
139
|
+
|
140
|
+
### Authorization
|
141
|
+
|
142
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
143
|
+
|
144
|
+
### HTTP request headers
|
145
|
+
|
146
|
+
- **Content-Type**: Not defined
|
147
|
+
- **Accept**: application/json
|
148
|
+
|
@@ -40,7 +40,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
|
|
40
40
|
main_format: yml,
|
41
41
|
media: Python,
|
42
42
|
shares_translation_memory: true,
|
43
|
-
project_image: [B@
|
43
|
+
project_image: [B@3dd916d9,
|
44
44
|
remove_project_image: null,
|
45
45
|
account_id: abcd1234,
|
46
46
|
point_of_contact: abcd1234,
|
@@ -41,7 +41,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
|
|
41
41
|
main_format: yml,
|
42
42
|
media: Python,
|
43
43
|
shares_translation_memory: true,
|
44
|
-
project_image: [B@
|
44
|
+
project_image: [B@7cdd8582,
|
45
45
|
remove_project_image: false,
|
46
46
|
workflow: review,
|
47
47
|
machine_translation_enabled: true,
|
data/docs/RepoSyncEvent.md
CHANGED
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
7
8
|
**event_type** | **String** | | [optional]
|
8
9
|
**created_at** | **Time** | | [optional]
|
9
10
|
**status** | **String** | | [optional]
|
@@ -16,7 +17,8 @@ Name | Type | Description | Notes
|
|
16
17
|
```ruby
|
17
18
|
require 'Phrase'
|
18
19
|
|
19
|
-
instance = Phrase::RepoSyncEvent.new(
|
20
|
+
instance = Phrase::RepoSyncEvent.new(id: null,
|
21
|
+
event_type: null,
|
20
22
|
created_at: null,
|
21
23
|
status: null,
|
22
24
|
pull_request_url: null,
|
data/docs/RepoSyncsApi.md
CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**repo_sync_activate**](RepoSyncsApi.md#repo_sync_activate) | **POST** /accounts/{account_id}/repo_syncs/{id}/activate | Activate a Repo Sync
|
8
8
|
[**repo_sync_deactivate**](RepoSyncsApi.md#repo_sync_deactivate) | **POST** /accounts/{account_id}/repo_syncs/{id}/deactivate | Deactivate a Repo Sync
|
9
|
+
[**repo_sync_event_show**](RepoSyncsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event
|
9
10
|
[**repo_sync_events**](RepoSyncsApi.md#repo_sync_events) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History
|
10
11
|
[**repo_sync_export**](RepoSyncsApi.md#repo_sync_export) | **POST** /accounts/{account_id}/repo_syncs/{id}/export | Export to code repository
|
11
12
|
[**repo_sync_import**](RepoSyncsApi.md#repo_sync_import) | **POST** /accounts/{account_id}/repo_syncs/{id}/import | Import from code repository
|
@@ -140,6 +141,71 @@ Response<([**RepoSync**](RepoSync.md))>
|
|
140
141
|
- **Accept**: application/json
|
141
142
|
|
142
143
|
|
144
|
+
## repo_sync_event_show
|
145
|
+
|
146
|
+
> RepoSyncEvent repo_sync_event_show(account_id, repo_sync_id, id, opts)
|
147
|
+
|
148
|
+
Get a single Repo Sync Event
|
149
|
+
|
150
|
+
Shows a single Repo Sync event.
|
151
|
+
|
152
|
+
### Example
|
153
|
+
|
154
|
+
```ruby
|
155
|
+
# load the gem
|
156
|
+
require 'phrase'
|
157
|
+
# setup authorization
|
158
|
+
Phrase.configure do |config|
|
159
|
+
# Configure HTTP basic authorization: Basic
|
160
|
+
config.username = 'YOUR USERNAME'
|
161
|
+
config.password = 'YOUR PASSWORD'
|
162
|
+
|
163
|
+
# Configure API key authorization: Token
|
164
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
165
|
+
config.api_key_prefix['Authorization'] = 'token'
|
166
|
+
end
|
167
|
+
|
168
|
+
api_instance = Phrase::RepoSyncsApi.new
|
169
|
+
account_id = 'account_id_example' # String | Account ID
|
170
|
+
repo_sync_id = 'repo_sync_id_example' # String | Repo Sync ID
|
171
|
+
id = 'id_example' # String | ID
|
172
|
+
opts = {
|
173
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
174
|
+
}
|
175
|
+
|
176
|
+
begin
|
177
|
+
#Get a single Repo Sync Event
|
178
|
+
result = api_instance.repo_sync_event_show(account_id, repo_sync_id, id, opts)
|
179
|
+
pp result
|
180
|
+
rescue Phrase::ApiError => e
|
181
|
+
puts "Exception when calling RepoSyncsApi->repo_sync_event_show: #{e}"
|
182
|
+
end
|
183
|
+
```
|
184
|
+
|
185
|
+
### Parameters
|
186
|
+
|
187
|
+
|
188
|
+
Name | Type | Description | Notes
|
189
|
+
------------- | ------------- | ------------- | -------------
|
190
|
+
**account_id** | **String**| Account ID |
|
191
|
+
**repo_sync_id** | **String**| Repo Sync ID |
|
192
|
+
**id** | **String**| ID |
|
193
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
194
|
+
|
195
|
+
### Return type
|
196
|
+
|
197
|
+
Response<([**RepoSyncEvent**](RepoSyncEvent.md))>
|
198
|
+
|
199
|
+
### Authorization
|
200
|
+
|
201
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
202
|
+
|
203
|
+
### HTTP request headers
|
204
|
+
|
205
|
+
- **Content-Type**: Not defined
|
206
|
+
- **Accept**: application/json
|
207
|
+
|
208
|
+
|
143
209
|
## repo_sync_events
|
144
210
|
|
145
211
|
> Array<RepoSyncEvent> repo_sync_events(account_id, id, opts)
|
@@ -205,7 +271,7 @@ Response<([**Array<RepoSyncEvent>**](RepoSyncEvent.md))>
|
|
205
271
|
|
206
272
|
## repo_sync_export
|
207
273
|
|
208
|
-
>
|
274
|
+
> RepoSyncEvent repo_sync_export(account_id, id, opts)
|
209
275
|
|
210
276
|
Export to code repository
|
211
277
|
|
@@ -254,7 +320,7 @@ Name | Type | Description | Notes
|
|
254
320
|
|
255
321
|
### Return type
|
256
322
|
|
257
|
-
Response<([**
|
323
|
+
Response<([**RepoSyncEvent**](RepoSyncEvent.md))>
|
258
324
|
|
259
325
|
### Authorization
|
260
326
|
|
@@ -268,7 +334,7 @@ Response<([**RepoSyncExport**](RepoSyncExport.md))>
|
|
268
334
|
|
269
335
|
## repo_sync_import
|
270
336
|
|
271
|
-
>
|
337
|
+
> RepoSyncEvent repo_sync_import(account_id, id, opts)
|
272
338
|
|
273
339
|
Import from code repository
|
274
340
|
|
@@ -317,7 +383,7 @@ Name | Type | Description | Notes
|
|
317
383
|
|
318
384
|
### Return type
|
319
385
|
|
320
|
-
Response<([**
|
386
|
+
Response<([**RepoSyncEvent**](RepoSyncEvent.md))>
|
321
387
|
|
322
388
|
### Authorization
|
323
389
|
|