phrase 3.1.0 → 3.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8f07b4c98a950f48e5247f88721f7d992792a5a7960e412f41cfc49b91bfe964
4
- data.tar.gz: 1fe829e23ddd4a971e6bf03bf48c3d974c82384e014ba1592a78e96e1da22db1
3
+ metadata.gz: e782332fdd45708285d70a00596b2ebd12da15c01917ea9b9277538b188a314d
4
+ data.tar.gz: d2a8c86ac88762ebbfd48e2e00f9428e6a8147d4a574fe2ccea48dbef4e05004
5
5
  SHA512:
6
- metadata.gz: 12ea91183ebd235348a63d93ee904d79772c3a76f503b4dc33d83e1ce4f2d47969b9e77c35e487663971e522ede349b63b8329a92ebbd617248d042f7cbed800
7
- data.tar.gz: 808604ae2041c0b35e52c9b9d075b087b461f0e9beca709683fdefe690d88305dfe69300862fa978bde47d12c9f04d25acf67e21b9705840795b5da2e9983deb
6
+ metadata.gz: 109885d9cbf9dd3d4f9a5493848707d453ff29657b8f9f2365e3f6efa78dd0a9f5ec253706751212bfdf5fdad9a081196d71adb705f75282d26e283924bb4a55
7
+ data.tar.gz: f76d4f641e8ef2847c7a5836b84bc74da470dda7551dcce8f1afc981112ae935b8cdaac936abc67022b5c31ff357cea4759a06c697a8e077fbbbad150a3a8f0e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # Changelog
2
2
 
3
+ ## [3.2.0](https://github.com/phrase/openapi/compare/ruby-v3.1.1...ruby-v3.2.0) (2024-06-12)
4
+
5
+
6
+ ### Features
7
+
8
+ * **API:** Add OTA Release Triggers API [TSI-2485] ([#622](https://github.com/phrase/openapi/issues/622)) ([8cb91dc](https://github.com/phrase/openapi/commit/8cb91dcce2c19ca700cf9d0713fa74f28ad59434))
9
+
10
+ ## [3.1.1](https://github.com/phrase/openapi/compare/ruby-v3.1.0...ruby-v3.1.1) (2024-05-31)
11
+
12
+
13
+ ### Bug Fixes
14
+
15
+ * **CLI:** use id instead of repo_sync_id as param ([#618](https://github.com/phrase/openapi/issues/618)) ([7a1a0d9](https://github.com/phrase/openapi/commit/7a1a0d9115262dc7fa3065ee7cc76bec7a381ddb))
16
+ * **PHP:** Fix deserializing custom metadata values in key response ([#607](https://github.com/phrase/openapi/issues/607)) ([b6eeeba](https://github.com/phrase/openapi/commit/b6eeeba223e3eabec268a8f3d372afcb6abd09dd))
17
+
3
18
  ## [3.1.0](https://github.com/phrase/openapi/compare/ruby-v3.0.0...ruby-v3.1.0) (2024-04-29)
4
19
 
5
20
 
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.1.0
10
+ - Package version: 3.2.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.1.0.gem
59
+ gem install ./phrase-3.2.0.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-3.1.0.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./phrase-3.2.0.gem` to install the development dependencies)
63
63
 
64
64
  ## Getting Started
65
65
 
@@ -310,19 +310,24 @@ Class | Method | HTTP request | Description
310
310
  *Phrase::ProjectsApi* | [**project_update**](docs/ProjectsApi.md#project_update) | **PATCH** /projects/{id} | Update a project
311
311
  *Phrase::ProjectsApi* | [**projects_list**](docs/ProjectsApi.md#projects_list) | **GET** /projects | List projects
312
312
  *Phrase::QualityPerformanceScoreApi* | [**projects_quality_performance_score**](docs/QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{project_id}/quality_performance_score | Get Translation Quality
313
+ *Phrase::ReleaseTriggersApi* | [**release_triggers_create**](docs/ReleaseTriggersApi.md#release_triggers_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/release_triggers | Create a release trigger
314
+ *Phrase::ReleaseTriggersApi* | [**release_triggers_destroy**](docs/ReleaseTriggersApi.md#release_triggers_destroy) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} | Delete a single release trigger
315
+ *Phrase::ReleaseTriggersApi* | [**release_triggers_list**](docs/ReleaseTriggersApi.md#release_triggers_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/release_triggers | List release triggers
316
+ *Phrase::ReleaseTriggersApi* | [**release_triggers_show**](docs/ReleaseTriggersApi.md#release_triggers_show) | **GET** /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} | Get a single release trigger
317
+ *Phrase::ReleaseTriggersApi* | [**release_triggers_update**](docs/ReleaseTriggersApi.md#release_triggers_update) | **PATCH** /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} | Update a release trigger
313
318
  *Phrase::ReleasesApi* | [**release_create**](docs/ReleasesApi.md#release_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
314
319
  *Phrase::ReleasesApi* | [**release_delete**](docs/ReleasesApi.md#release_delete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
315
320
  *Phrase::ReleasesApi* | [**release_publish**](docs/ReleasesApi.md#release_publish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release
316
321
  *Phrase::ReleasesApi* | [**release_show**](docs/ReleasesApi.md#release_show) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Get a single release
317
322
  *Phrase::ReleasesApi* | [**release_update**](docs/ReleasesApi.md#release_update) | **PATCH** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Update a release
318
323
  *Phrase::ReleasesApi* | [**releases_list**](docs/ReleasesApi.md#releases_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases | List releases
319
- *Phrase::RepoSyncsApi* | [**repo_sync_activate**](docs/RepoSyncsApi.md#repo_sync_activate) | **POST** /accounts/{account_id}/repo_syncs/{repo_sync_id}/activate | Activate a Repo Sync
320
- *Phrase::RepoSyncsApi* | [**repo_sync_deactivate**](docs/RepoSyncsApi.md#repo_sync_deactivate) | **POST** /accounts/{account_id}/repo_syncs/{repo_sync_id}/deactivate | Deactivate a Repo Sync
321
- *Phrase::RepoSyncsApi* | [**repo_sync_events**](docs/RepoSyncsApi.md#repo_sync_events) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events | Repository Syncs History
322
- *Phrase::RepoSyncsApi* | [**repo_sync_export**](docs/RepoSyncsApi.md#repo_sync_export) | **POST** /accounts/{account_id}/repo_syncs/{repo_sync_id}/export | Export to code repository
323
- *Phrase::RepoSyncsApi* | [**repo_sync_import**](docs/RepoSyncsApi.md#repo_sync_import) | **POST** /accounts/{account_id}/repo_syncs/{repo_sync_id}/import | Import from code repository
324
+ *Phrase::RepoSyncsApi* | [**repo_sync_activate**](docs/RepoSyncsApi.md#repo_sync_activate) | **POST** /accounts/{account_id}/repo_syncs/{id}/activate | Activate a Repo Sync
325
+ *Phrase::RepoSyncsApi* | [**repo_sync_deactivate**](docs/RepoSyncsApi.md#repo_sync_deactivate) | **POST** /accounts/{account_id}/repo_syncs/{id}/deactivate | Deactivate a Repo Sync
326
+ *Phrase::RepoSyncsApi* | [**repo_sync_events**](docs/RepoSyncsApi.md#repo_sync_events) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History
327
+ *Phrase::RepoSyncsApi* | [**repo_sync_export**](docs/RepoSyncsApi.md#repo_sync_export) | **POST** /accounts/{account_id}/repo_syncs/{id}/export | Export to code repository
328
+ *Phrase::RepoSyncsApi* | [**repo_sync_import**](docs/RepoSyncsApi.md#repo_sync_import) | **POST** /accounts/{account_id}/repo_syncs/{id}/import | Import from code repository
324
329
  *Phrase::RepoSyncsApi* | [**repo_sync_list**](docs/RepoSyncsApi.md#repo_sync_list) | **GET** /accounts/{account_id}/repo_syncs | Get Repo Syncs
325
- *Phrase::RepoSyncsApi* | [**repo_sync_show**](docs/RepoSyncsApi.md#repo_sync_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id} | Get a single Repo Sync
330
+ *Phrase::RepoSyncsApi* | [**repo_sync_show**](docs/RepoSyncsApi.md#repo_sync_show) | **GET** /accounts/{account_id}/repo_syncs/{id} | Get a single Repo Sync
326
331
  *Phrase::ReportsApi* | [**report_locales_list**](docs/ReportsApi.md#report_locales_list) | **GET** /projects/{project_id}/report/locales | List Locale Reports
327
332
  *Phrase::ReportsApi* | [**report_show**](docs/ReportsApi.md#report_show) | **GET** /projects/{project_id}/report | Get Project Report
328
333
  *Phrase::ScreenshotMarkersApi* | [**screenshot_marker_create**](docs/ScreenshotMarkersApi.md#screenshot_marker_create) | **POST** /projects/{project_id}/screenshots/{screenshot_id}/markers | Create a screenshot marker
@@ -553,8 +558,11 @@ Class | Method | HTTP request | Description
553
558
  - [Phrase::ProjectsQualityPerformanceScoreRequest](docs/ProjectsQualityPerformanceScoreRequest.md)
554
559
  - [Phrase::Release](docs/Release.md)
555
560
  - [Phrase::ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
561
+ - [Phrase::ReleaseCreateParameters1](docs/ReleaseCreateParameters1.md)
556
562
  - [Phrase::ReleasePreview](docs/ReleasePreview.md)
563
+ - [Phrase::ReleaseTrigger](docs/ReleaseTrigger.md)
557
564
  - [Phrase::ReleaseUpdateParameters](docs/ReleaseUpdateParameters.md)
565
+ - [Phrase::ReleaseUpdateParameters1](docs/ReleaseUpdateParameters1.md)
558
566
  - [Phrase::RepliesListParameters](docs/RepliesListParameters.md)
559
567
  - [Phrase::RepoSync](docs/RepoSync.md)
560
568
  - [Phrase::RepoSyncEvent](docs/RepoSyncEvent.md)
@@ -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@171dbfa0,
38
+ screenshot: [B@68017525,
39
39
  remove_screenshot: null,
40
40
  unformatted: null,
41
41
  default_translation_content: Default translation content,
@@ -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@3dfb1cec,
37
+ screenshot: [B@434d5eb9,
38
38
  remove_screenshot: null,
39
39
  unformatted: null,
40
40
  xml_space_preserve: null,
data/docs/LocaleReport.md CHANGED
@@ -5,10 +5,10 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **keys_count** | **Integer** | | [optional]
8
- **translated_translations_percentage** | **Integer** | | [optional]
9
- **unverified_translations_percentage** | **Integer** | | [optional]
10
- **reviewed_translations_percentage** | **Integer** | | [optional]
11
- **untranslated_keys_percentage** | **Integer** | | [optional]
8
+ **translated_translations_percentage** | **Float** | | [optional]
9
+ **unverified_translations_percentage** | **Float** | | [optional]
10
+ **reviewed_translations_percentage** | **Float** | | [optional]
11
+ **untranslated_keys_percentage** | **Float** | | [optional]
12
12
  **completed_translations_count** | **Integer** | | [optional]
13
13
  **untranslated_keys_count** | **Integer** | | [optional]
14
14
  **unverified_translations_count** | **Integer** | | [optional]
@@ -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@4b2c95ff,
43
+ project_image: [B@4cec414d,
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@19266d52,
44
+ project_image: [B@62a939cd,
45
45
  remove_project_image: false,
46
46
  workflow: review,
47
47
  machine_translation_enabled: true,
@@ -0,0 +1,29 @@
1
+ # Phrase::ReleaseCreateParameters1
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **cron_schedule** | **String** | Cron schedule for the scheduler. Read more about the format of this field at https://en.wikipedia.org/wiki/Cron | [optional]
8
+ **time_zone** | **String** | Time zone for the scheduler | [optional]
9
+ **locale_ids** | **Array<String>** | List of locale ids that will be included in the release. | [optional]
10
+ **tags** | **Array<String>** | Only include tagged keys in the release. For a key to be included it must be tagged with all tags provided | [optional]
11
+ **branch** | **String** | Branch used for release | [optional]
12
+ **app_min_version** | **String** | The created releases will be available only for apps with version greater or equal to this value | [optional]
13
+ **app_max_version** | **String** | The created releases will be available only for apps with version less or equal to this value | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'Phrase'
19
+
20
+ instance = Phrase::ReleaseCreateParameters1.new(cron_schedule: 15 18 * * 1,3,
21
+ time_zone: Europe/Berlin,
22
+ locale_ids: ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],
23
+ tags: ["android","feature1"],
24
+ branch: my-feature-branch,
25
+ app_min_version: 1.0.0,
26
+ app_max_version: 2.0.0)
27
+ ```
28
+
29
+
@@ -0,0 +1,37 @@
1
+ # Phrase::ReleaseTrigger
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | | [optional]
8
+ **branch** | **String** | | [optional]
9
+ **cron_schedule** | **String** | Cron schedule for the scheduler. Read more about the format of this field at https://en.wikipedia.org/wiki/Cron | [optional]
10
+ **time_zone** | **String** | Time zone for the scheduler | [optional]
11
+ **next_run_at** | **Time** | The next time a release will be created for this trigger | [optional]
12
+ **app_min_version** | **String** | | [optional]
13
+ **app_max_version** | **String** | | [optional]
14
+ **locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
15
+ **tags** | **Array<String>** | | [optional]
16
+ **created_at** | **Time** | | [optional]
17
+ **updated_at** | **Time** | | [optional]
18
+
19
+ ## Code Sample
20
+
21
+ ```ruby
22
+ require 'Phrase'
23
+
24
+ instance = Phrase::ReleaseTrigger.new(id: null,
25
+ branch: null,
26
+ cron_schedule: null,
27
+ time_zone: null,
28
+ next_run_at: null,
29
+ app_min_version: null,
30
+ app_max_version: null,
31
+ locales: null,
32
+ tags: null,
33
+ created_at: null,
34
+ updated_at: null)
35
+ ```
36
+
37
+
@@ -0,0 +1,337 @@
1
+ # Phrase::ReleaseTriggersApi
2
+
3
+ All URIs are relative to *https://api.phrase.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**release_triggers_create**](ReleaseTriggersApi.md#release_triggers_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/release_triggers | Create a release trigger
8
+ [**release_triggers_destroy**](ReleaseTriggersApi.md#release_triggers_destroy) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} | Delete a single release trigger
9
+ [**release_triggers_list**](ReleaseTriggersApi.md#release_triggers_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/release_triggers | List release triggers
10
+ [**release_triggers_show**](ReleaseTriggersApi.md#release_triggers_show) | **GET** /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} | Get a single release trigger
11
+ [**release_triggers_update**](ReleaseTriggersApi.md#release_triggers_update) | **PATCH** /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} | Update a release trigger
12
+
13
+
14
+
15
+ ## release_triggers_create
16
+
17
+ > ReleaseTrigger release_triggers_create(account_id, distribution_id, release_create_parameters1, opts)
18
+
19
+ Create a release trigger
20
+
21
+ Create a new recurring release. New releases will be published automatically, based on the cron schedule provided. Currently, only one release trigger can exist per distribution.
22
+
23
+ ### Example
24
+
25
+ ```ruby
26
+ # load the gem
27
+ require 'phrase'
28
+ # setup authorization
29
+ Phrase.configure do |config|
30
+ # Configure HTTP basic authorization: Basic
31
+ config.username = 'YOUR USERNAME'
32
+ config.password = 'YOUR PASSWORD'
33
+
34
+ # Configure API key authorization: Token
35
+ config.api_key['Authorization'] = 'YOUR API KEY'
36
+ config.api_key_prefix['Authorization'] = 'token'
37
+ end
38
+
39
+ api_instance = Phrase::ReleaseTriggersApi.new
40
+ account_id = 'account_id_example' # String | Account ID
41
+ distribution_id = 'distribution_id_example' # String | Distribution ID
42
+ release_create_parameters1 = Phrase::ReleaseCreateParameters1.new # ReleaseCreateParameters1 |
43
+ opts = {
44
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
45
+ }
46
+
47
+ begin
48
+ #Create a release trigger
49
+ result = api_instance.release_triggers_create(account_id, distribution_id, release_create_parameters1, opts)
50
+ pp result
51
+ rescue Phrase::ApiError => e
52
+ puts "Exception when calling ReleaseTriggersApi->release_triggers_create: #{e}"
53
+ end
54
+ ```
55
+
56
+ ### Parameters
57
+
58
+
59
+ Name | Type | Description | Notes
60
+ ------------- | ------------- | ------------- | -------------
61
+ **account_id** | **String**| Account ID |
62
+ **distribution_id** | **String**| Distribution ID |
63
+ **release_create_parameters1** | [**ReleaseCreateParameters1**](ReleaseCreateParameters1.md)| |
64
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
65
+
66
+ ### Return type
67
+
68
+ Response<([**ReleaseTrigger**](ReleaseTrigger.md))>
69
+
70
+ ### Authorization
71
+
72
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: application/json
77
+ - **Accept**: application/json
78
+
79
+
80
+ ## release_triggers_destroy
81
+
82
+ > release_triggers_destroy(account_id, distribution_id, id, opts)
83
+
84
+ Delete a single release trigger
85
+
86
+ Delete a single release trigger.
87
+
88
+ ### Example
89
+
90
+ ```ruby
91
+ # load the gem
92
+ require 'phrase'
93
+ # setup authorization
94
+ Phrase.configure do |config|
95
+ # Configure HTTP basic authorization: Basic
96
+ config.username = 'YOUR USERNAME'
97
+ config.password = 'YOUR PASSWORD'
98
+
99
+ # Configure API key authorization: Token
100
+ config.api_key['Authorization'] = 'YOUR API KEY'
101
+ config.api_key_prefix['Authorization'] = 'token'
102
+ end
103
+
104
+ api_instance = Phrase::ReleaseTriggersApi.new
105
+ account_id = 'account_id_example' # String | Account ID
106
+ distribution_id = 'distribution_id_example' # String | Distribution ID
107
+ id = 'id_example' # String | ID
108
+ opts = {
109
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
110
+ }
111
+
112
+ begin
113
+ #Delete a single release trigger
114
+ api_instance.release_triggers_destroy(account_id, distribution_id, id, opts)
115
+ rescue Phrase::ApiError => e
116
+ puts "Exception when calling ReleaseTriggersApi->release_triggers_destroy: #{e}"
117
+ end
118
+ ```
119
+
120
+ ### Parameters
121
+
122
+
123
+ Name | Type | Description | Notes
124
+ ------------- | ------------- | ------------- | -------------
125
+ **account_id** | **String**| Account ID |
126
+ **distribution_id** | **String**| Distribution ID |
127
+ **id** | **String**| ID |
128
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
129
+
130
+ ### Return type
131
+
132
+ Response<(nil (empty response body))>
133
+
134
+ ### Authorization
135
+
136
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
137
+
138
+ ### HTTP request headers
139
+
140
+ - **Content-Type**: Not defined
141
+ - **Accept**: Not defined
142
+
143
+
144
+ ## release_triggers_list
145
+
146
+ > Array&lt;ReleaseTrigger&gt; release_triggers_list(account_id, distribution_id, opts)
147
+
148
+ List release triggers
149
+
150
+ List all release triggers for the given distribution.<br> Note: Currently only one release trigger can exist per distribution.
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::ReleaseTriggersApi.new
169
+ account_id = 'account_id_example' # String | Account ID
170
+ distribution_id = 'distribution_id_example' # String | Distribution ID
171
+ opts = {
172
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
173
+ }
174
+
175
+ begin
176
+ #List release triggers
177
+ result = api_instance.release_triggers_list(account_id, distribution_id, opts)
178
+ pp result
179
+ rescue Phrase::ApiError => e
180
+ puts "Exception when calling ReleaseTriggersApi->release_triggers_list: #{e}"
181
+ end
182
+ ```
183
+
184
+ ### Parameters
185
+
186
+
187
+ Name | Type | Description | Notes
188
+ ------------- | ------------- | ------------- | -------------
189
+ **account_id** | **String**| Account ID |
190
+ **distribution_id** | **String**| Distribution ID |
191
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
192
+
193
+ ### Return type
194
+
195
+ Response<([**Array&lt;ReleaseTrigger&gt;**](ReleaseTrigger.md))>
196
+
197
+ ### Authorization
198
+
199
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
200
+
201
+ ### HTTP request headers
202
+
203
+ - **Content-Type**: Not defined
204
+ - **Accept**: application/json
205
+
206
+
207
+ ## release_triggers_show
208
+
209
+ > ReleaseTrigger release_triggers_show(account_id, distribution_id, id, opts)
210
+
211
+ Get a single release trigger
212
+
213
+ Get details of a single release trigger.
214
+
215
+ ### Example
216
+
217
+ ```ruby
218
+ # load the gem
219
+ require 'phrase'
220
+ # setup authorization
221
+ Phrase.configure do |config|
222
+ # Configure HTTP basic authorization: Basic
223
+ config.username = 'YOUR USERNAME'
224
+ config.password = 'YOUR PASSWORD'
225
+
226
+ # Configure API key authorization: Token
227
+ config.api_key['Authorization'] = 'YOUR API KEY'
228
+ config.api_key_prefix['Authorization'] = 'token'
229
+ end
230
+
231
+ api_instance = Phrase::ReleaseTriggersApi.new
232
+ account_id = 'account_id_example' # String | Account ID
233
+ distribution_id = 'distribution_id_example' # String | Distribution ID
234
+ id = 'id_example' # String | ID
235
+ opts = {
236
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
237
+ }
238
+
239
+ begin
240
+ #Get a single release trigger
241
+ result = api_instance.release_triggers_show(account_id, distribution_id, id, opts)
242
+ pp result
243
+ rescue Phrase::ApiError => e
244
+ puts "Exception when calling ReleaseTriggersApi->release_triggers_show: #{e}"
245
+ end
246
+ ```
247
+
248
+ ### Parameters
249
+
250
+
251
+ Name | Type | Description | Notes
252
+ ------------- | ------------- | ------------- | -------------
253
+ **account_id** | **String**| Account ID |
254
+ **distribution_id** | **String**| Distribution ID |
255
+ **id** | **String**| ID |
256
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
257
+
258
+ ### Return type
259
+
260
+ Response<([**ReleaseTrigger**](ReleaseTrigger.md))>
261
+
262
+ ### Authorization
263
+
264
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
265
+
266
+ ### HTTP request headers
267
+
268
+ - **Content-Type**: Not defined
269
+ - **Accept**: application/json
270
+
271
+
272
+ ## release_triggers_update
273
+
274
+ > ReleaseTrigger release_triggers_update(account_id, distribution_id, id, release_update_parameters1, opts)
275
+
276
+ Update a release trigger
277
+
278
+ Update a recurring release.
279
+
280
+ ### Example
281
+
282
+ ```ruby
283
+ # load the gem
284
+ require 'phrase'
285
+ # setup authorization
286
+ Phrase.configure do |config|
287
+ # Configure HTTP basic authorization: Basic
288
+ config.username = 'YOUR USERNAME'
289
+ config.password = 'YOUR PASSWORD'
290
+
291
+ # Configure API key authorization: Token
292
+ config.api_key['Authorization'] = 'YOUR API KEY'
293
+ config.api_key_prefix['Authorization'] = 'token'
294
+ end
295
+
296
+ api_instance = Phrase::ReleaseTriggersApi.new
297
+ account_id = 'account_id_example' # String | Account ID
298
+ distribution_id = 'distribution_id_example' # String | Distribution ID
299
+ id = 'id_example' # String | ID
300
+ release_update_parameters1 = Phrase::ReleaseUpdateParameters1.new # ReleaseUpdateParameters1 |
301
+ opts = {
302
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
303
+ }
304
+
305
+ begin
306
+ #Update a release trigger
307
+ result = api_instance.release_triggers_update(account_id, distribution_id, id, release_update_parameters1, opts)
308
+ pp result
309
+ rescue Phrase::ApiError => e
310
+ puts "Exception when calling ReleaseTriggersApi->release_triggers_update: #{e}"
311
+ end
312
+ ```
313
+
314
+ ### Parameters
315
+
316
+
317
+ Name | Type | Description | Notes
318
+ ------------- | ------------- | ------------- | -------------
319
+ **account_id** | **String**| Account ID |
320
+ **distribution_id** | **String**| Distribution ID |
321
+ **id** | **String**| ID |
322
+ **release_update_parameters1** | [**ReleaseUpdateParameters1**](ReleaseUpdateParameters1.md)| |
323
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
324
+
325
+ ### Return type
326
+
327
+ Response<([**ReleaseTrigger**](ReleaseTrigger.md))>
328
+
329
+ ### Authorization
330
+
331
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
332
+
333
+ ### HTTP request headers
334
+
335
+ - **Content-Type**: application/json
336
+ - **Accept**: application/json
337
+
@@ -0,0 +1,29 @@
1
+ # Phrase::ReleaseUpdateParameters1
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **cron_schedule** | **String** | Cron schedule for the scheduler. Read more about the format of this field at https://en.wikipedia.org/wiki/Cron | [optional]
8
+ **time_zone** | **String** | Time zone for the scheduler | [optional]
9
+ **locale_ids** | **Array&lt;String&gt;** | List of locale ids that will be included in the release. | [optional]
10
+ **tags** | **Array&lt;String&gt;** | Only include tagged keys in the release. For a key to be included it must be tagged with all tags provided | [optional]
11
+ **branch** | **String** | Branch used for release | [optional]
12
+ **app_min_version** | **String** | The created releases will be available only for apps with version greater or equal to this value | [optional]
13
+ **app_max_version** | **String** | The created releases will be available only for apps with version less or equal to this value | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'Phrase'
19
+
20
+ instance = Phrase::ReleaseUpdateParameters1.new(cron_schedule: 15 18 * * 1,3,
21
+ time_zone: Europe/Berlin,
22
+ locale_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;,&quot;fff565db236400772368235db2c6117e&quot;],
23
+ tags: [&quot;android&quot;,&quot;feature1&quot;],
24
+ branch: my-feature-branch,
25
+ app_min_version: 1.0.0,
26
+ app_max_version: 2.0.0)
27
+ ```
28
+
29
+