phrase 2.8.2 → 2.8.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +15 -12
- data/docs/AccountsApi.md +2 -2
- data/docs/AuthorizationsApi.md +2 -2
- data/docs/BitbucketSyncApi.md +2 -2
- data/docs/BlacklistedKeysApi.md +2 -2
- data/docs/BranchesApi.md +5 -5
- data/docs/CommentsApi.md +2 -2
- data/docs/DistributionsApi.md +2 -2
- data/docs/DocumentsApi.md +2 -2
- data/docs/GitHubSyncApi.md +2 -2
- data/docs/GitLabSyncApi.md +4 -4
- data/docs/GlossariesApi.md +2 -2
- data/docs/GlossaryTermsApi.md +2 -2
- data/docs/InvitationsApi.md +2 -2
- data/docs/JobCommentsApi.md +6 -6
- data/docs/JobLocale.md +3 -1
- data/docs/JobLocaleUpdateParameters.md +5 -1
- data/docs/JobLocalesApi.md +2 -2
- data/docs/JobLocalesCreateParameters.md +6 -2
- data/docs/JobTemplateDetails.md +35 -0
- data/docs/JobTemplateDetails1.md +21 -0
- data/docs/JobTemplateLocaleUpdateParameters.md +6 -2
- data/docs/{JobTemplateLocale.md → JobTemplateLocales.md} +6 -4
- data/docs/JobTemplateLocalesApi.md +10 -10
- data/docs/JobTemplateLocalesCreateParameters.md +5 -1
- data/docs/JobTemplatesApi.md +41 -41
- data/docs/JobsApi.md +4 -4
- data/docs/KeysApi.md +4 -4
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/LocaleTeamPreview.md +21 -0
- data/docs/{JobTemplateUserPreview.md → LocaleUserPreview.md} +2 -2
- data/docs/LocalesApi.md +12 -8
- data/docs/MembersApi.md +2 -2
- data/docs/NotificationGroupDetail.md +1 -1
- data/docs/NotificationGroupsApi.md +6 -6
- data/docs/NotificationsApi.md +8 -6
- data/docs/OrdersApi.md +2 -2
- data/docs/Project.md +2 -0
- data/docs/ProjectCreateParameters.md +5 -1
- data/docs/ProjectDetails.md +2 -0
- data/docs/ProjectUpdateParameters.md +5 -1
- data/docs/ProjectsApi.md +2 -2
- data/docs/ReleasesApi.md +2 -2
- data/docs/ScreenshotMarkersApi.md +2 -2
- data/docs/ScreenshotsApi.md +2 -2
- data/docs/SearchApi.md +1 -1
- data/docs/SpacesApi.md +4 -4
- data/docs/StyleGuidesApi.md +2 -2
- data/docs/TagsApi.md +2 -2
- data/docs/TeamsApi.md +2 -2
- data/docs/TranslationsApi.md +31 -27
- 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/UploadsApi.md +5 -5
- data/docs/VariablesApi.md +2 -2
- data/docs/VersionsHistoryApi.md +2 -2
- data/docs/WebhooksApi.md +2 -2
- data/lib/phrase/api/accounts_api.rb +2 -2
- data/lib/phrase/api/authorizations_api.rb +2 -2
- data/lib/phrase/api/bitbucket_sync_api.rb +4 -4
- data/lib/phrase/api/blacklisted_keys_api.rb +2 -2
- data/lib/phrase/api/branches_api.rb +8 -8
- data/lib/phrase/api/comments_api.rb +2 -2
- data/lib/phrase/api/distributions_api.rb +2 -2
- data/lib/phrase/api/documents_api.rb +2 -2
- data/lib/phrase/api/git_hub_sync_api.rb +4 -4
- data/lib/phrase/api/git_lab_sync_api.rb +6 -6
- data/lib/phrase/api/glossaries_api.rb +2 -2
- data/lib/phrase/api/glossary_terms_api.rb +2 -2
- data/lib/phrase/api/invitations_api.rb +2 -2
- data/lib/phrase/api/job_comments_api.rb +9 -9
- data/lib/phrase/api/job_locales_api.rb +2 -2
- data/lib/phrase/api/job_template_locales_api.rb +14 -14
- data/lib/phrase/api/job_templates_api.rb +72 -72
- data/lib/phrase/api/jobs_api.rb +4 -4
- data/lib/phrase/api/keys_api.rb +4 -4
- data/lib/phrase/api/locales_api.rb +14 -8
- data/lib/phrase/api/members_api.rb +2 -2
- data/lib/phrase/api/notification_groups_api.rb +8 -8
- data/lib/phrase/api/notifications_api.rb +11 -8
- data/lib/phrase/api/orders_api.rb +2 -2
- data/lib/phrase/api/projects_api.rb +2 -2
- data/lib/phrase/api/releases_api.rb +2 -2
- data/lib/phrase/api/screenshot_markers_api.rb +2 -2
- data/lib/phrase/api/screenshots_api.rb +2 -2
- data/lib/phrase/api/search_api.rb +2 -2
- data/lib/phrase/api/spaces_api.rb +4 -4
- data/lib/phrase/api/style_guides_api.rb +2 -2
- data/lib/phrase/api/tags_api.rb +2 -2
- data/lib/phrase/api/teams_api.rb +2 -2
- data/lib/phrase/api/translations_api.rb +28 -22
- data/lib/phrase/api/uploads_api.rb +4 -4
- data/lib/phrase/api/variables_api.rb +2 -2
- data/lib/phrase/api/versions_history_api.rb +2 -2
- data/lib/phrase/api/webhooks_api.rb +2 -2
- data/lib/phrase/models/job_locale.rb +13 -2
- data/lib/phrase/models/job_locale_update_parameters.rb +28 -4
- data/lib/phrase/models/job_locales_create_parameters.rb +33 -4
- data/lib/phrase/models/job_template_details.rb +285 -0
- data/lib/phrase/models/job_template_details1.rb +214 -0
- data/lib/phrase/models/job_template_locale_update_parameters.rb +28 -9
- data/lib/phrase/models/{job_template_locale.rb → job_template_locales.rb} +18 -7
- data/lib/phrase/models/job_template_locales_create_parameters.rb +28 -4
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/locale_team_preview.rb +212 -0
- data/lib/phrase/models/{job_template_user_preview.rb → locale_user_preview.rb} +3 -3
- data/lib/phrase/models/notification_group_detail.rb +1 -1
- data/lib/phrase/models/project.rb +10 -1
- data/lib/phrase/models/project_create_parameters.rb +22 -2
- data/lib/phrase/models/project_details.rb +10 -1
- data/lib/phrase/models/project_update_parameters.rb +22 -2
- 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/version.rb +1 -1
- data/lib/phrase.rb +5 -2
- data/spec/api/accounts_api_spec.rb +1 -1
- data/spec/api/authorizations_api_spec.rb +1 -1
- data/spec/api/bitbucket_sync_api_spec.rb +2 -2
- data/spec/api/blacklisted_keys_api_spec.rb +1 -1
- data/spec/api/branches_api_spec.rb +4 -4
- data/spec/api/comments_api_spec.rb +1 -1
- data/spec/api/distributions_api_spec.rb +1 -1
- data/spec/api/documents_api_spec.rb +1 -1
- data/spec/api/git_hub_sync_api_spec.rb +2 -2
- data/spec/api/git_lab_sync_api_spec.rb +3 -3
- data/spec/api/glossaries_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_comments_api_spec.rb +3 -3
- data/spec/api/job_locales_api_spec.rb +1 -1
- data/spec/api/job_template_locales_api_spec.rb +5 -5
- data/spec/api/job_templates_api_spec.rb +18 -18
- data/spec/api/jobs_api_spec.rb +2 -2
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/locales_api_spec.rb +6 -4
- data/spec/api/members_api_spec.rb +1 -1
- data/spec/api/notification_groups_api_spec.rb +3 -3
- data/spec/api/notifications_api_spec.rb +4 -3
- 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/search_api_spec.rb +1 -1
- data/spec/api/spaces_api_spec.rb +2 -2
- 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 +1 -1
- data/spec/api/translations_api_spec.rb +13 -11
- data/spec/api/uploads_api_spec.rb +2 -2
- data/spec/api/variables_api_spec.rb +1 -1
- data/spec/api/versions_history_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/models/job_locale_spec.rb +6 -0
- data/spec/models/job_locale_update_parameters_spec.rb +12 -0
- data/spec/models/job_locales_create_parameters_spec.rb +12 -0
- data/spec/models/job_template_details1_spec.rb +41 -0
- data/spec/models/job_template_details_spec.rb +83 -0
- data/spec/models/job_template_locale_update_parameters_spec.rb +12 -0
- data/spec/models/job_template_locales_create_parameters_spec.rb +12 -0
- data/spec/models/{job_template_locale_spec.rb → job_template_locales_spec.rb} +12 -6
- data/spec/models/locale_team_preview_spec.rb +41 -0
- data/spec/models/{job_template_user_preview_spec.rb → locale_user_preview_spec.rb} +6 -6
- data/spec/models/project_create_parameters_spec.rb +12 -0
- data/spec/models/project_details_spec.rb +6 -0
- data/spec/models/project_spec.rb +6 -0
- data/spec/models/project_update_parameters_spec.rb +12 -0
- metadata +237 -225
@@ -1,4 +1,4 @@
|
|
1
|
-
# Phrase::
|
1
|
+
# Phrase::JobTemplateLocales
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -7,17 +7,19 @@ Name | Type | Description | Notes
|
|
7
7
|
**id** | **String** | | [optional]
|
8
8
|
**job_template** | [**JobTemplatePreview**](JobTemplatePreview.md) | | [optional]
|
9
9
|
**locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
10
|
-
**users** | [**Array<
|
10
|
+
**users** | [**Array<LocaleUserPreview>**](LocaleUserPreview.md) | | [optional]
|
11
|
+
**teams** | [**Array<LocaleTeamPreview>**](LocaleTeamPreview.md) | | [optional]
|
11
12
|
|
12
13
|
## Code Sample
|
13
14
|
|
14
15
|
```ruby
|
15
16
|
require 'Phrase'
|
16
17
|
|
17
|
-
instance = Phrase::
|
18
|
+
instance = Phrase::JobTemplateLocales.new(id: null,
|
18
19
|
job_template: null,
|
19
20
|
locale: null,
|
20
|
-
users: null
|
21
|
+
users: null,
|
22
|
+
teams: null)
|
21
23
|
```
|
22
24
|
|
23
25
|
|
@@ -80,7 +80,7 @@ Response<(nil (empty response body))>
|
|
80
80
|
|
81
81
|
## job_template_locale_show
|
82
82
|
|
83
|
-
>
|
83
|
+
> JobTemplateLocales job_template_locale_show(project_id, job_template_id, job_template_locale_id, opts)
|
84
84
|
|
85
85
|
Get a single job template locale
|
86
86
|
|
@@ -133,7 +133,7 @@ Name | Type | Description | Notes
|
|
133
133
|
|
134
134
|
### Return type
|
135
135
|
|
136
|
-
Response<(**
|
136
|
+
Response<([**JobTemplateLocales**](JobTemplateLocales.md))>
|
137
137
|
|
138
138
|
### Authorization
|
139
139
|
|
@@ -147,7 +147,7 @@ Response<(**Object**)>
|
|
147
147
|
|
148
148
|
## job_template_locale_update
|
149
149
|
|
150
|
-
>
|
150
|
+
> JobTemplateLocales job_template_locale_update(project_id, job_template_id, job_template_locale_id, job_template_locale_update_parameters, opts)
|
151
151
|
|
152
152
|
Update a job template locale
|
153
153
|
|
@@ -200,7 +200,7 @@ Name | Type | Description | Notes
|
|
200
200
|
|
201
201
|
### Return type
|
202
202
|
|
203
|
-
Response<(**
|
203
|
+
Response<([**JobTemplateLocales**](JobTemplateLocales.md))>
|
204
204
|
|
205
205
|
### Authorization
|
206
206
|
|
@@ -214,7 +214,7 @@ Response<(**Object**)>
|
|
214
214
|
|
215
215
|
## job_template_locales_create
|
216
216
|
|
217
|
-
>
|
217
|
+
> JobTemplateLocales job_template_locales_create(project_id, job_template_id, job_template_locales_create_parameters, opts)
|
218
218
|
|
219
219
|
Create a job template locale
|
220
220
|
|
@@ -265,7 +265,7 @@ Name | Type | Description | Notes
|
|
265
265
|
|
266
266
|
### Return type
|
267
267
|
|
268
|
-
Response<([**
|
268
|
+
Response<([**JobTemplateLocales**](JobTemplateLocales.md))>
|
269
269
|
|
270
270
|
### Authorization
|
271
271
|
|
@@ -279,7 +279,7 @@ Response<([**JobTemplateLocale**](JobTemplateLocale.md))>
|
|
279
279
|
|
280
280
|
## job_template_locales_list
|
281
281
|
|
282
|
-
> Array<
|
282
|
+
> Array<JobTemplateLocales> job_template_locales_list(project_id, job_template_id, opts)
|
283
283
|
|
284
284
|
List job template locales
|
285
285
|
|
@@ -307,7 +307,7 @@ job_template_id = 'job_template_id_example' # String | Job Template ID
|
|
307
307
|
opts = {
|
308
308
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
309
309
|
page: 1, # Integer | Page number
|
310
|
-
per_page: 25, # Integer |
|
310
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
311
311
|
branch: 'my-feature-branch' # String | specify the branch to use
|
312
312
|
}
|
313
313
|
|
@@ -329,12 +329,12 @@ Name | Type | Description | Notes
|
|
329
329
|
**job_template_id** | **String**| Job Template ID |
|
330
330
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
331
331
|
**page** | **Integer**| Page number | [optional]
|
332
|
-
**per_page** | **Integer**|
|
332
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
333
333
|
**branch** | **String**| specify the branch to use | [optional]
|
334
334
|
|
335
335
|
### Return type
|
336
336
|
|
337
|
-
Response<(**Array<
|
337
|
+
Response<([**Array<JobTemplateLocales>**](JobTemplateLocales.md))>
|
338
338
|
|
339
339
|
### Authorization
|
340
340
|
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
8
8
|
**locale_id** | **String** | locale id |
|
9
9
|
**user_ids** | **Array<String>** | Array of user ids to be assigned to the job template locale | [optional]
|
10
10
|
**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job template locale | [optional]
|
11
|
+
**translator_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as translators | [optional]
|
12
|
+
**reviewer_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as reviewers | [optional]
|
11
13
|
|
12
14
|
## Code Sample
|
13
15
|
|
@@ -17,7 +19,9 @@ require 'Phrase'
|
|
17
19
|
instance = Phrase::JobTemplateLocalesCreateParameters.new(branch: my-feature-branch,
|
18
20
|
locale_id: abcd1234cdef1234abcd1234cdef1234,
|
19
21
|
user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
20
|
-
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"]
|
22
|
+
reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
23
|
+
translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
|
24
|
+
reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
21
25
|
```
|
22
26
|
|
23
27
|
|
data/docs/JobTemplatesApi.md
CHANGED
@@ -6,15 +6,15 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**job_template_create**](JobTemplatesApi.md#job_template_create) | **POST** /projects/{project_id}/job_templates | Create a job template
|
8
8
|
[**job_template_delete**](JobTemplatesApi.md#job_template_delete) | **DELETE** /projects/{project_id}/job_templates/{id} | Delete a job template
|
9
|
-
[**job_template_show**](JobTemplatesApi.md#job_template_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
|
10
9
|
[**job_template_update**](JobTemplatesApi.md#job_template_update) | **PATCH** /projects/{project_id}/job_templates/{id} | Update a job template
|
11
10
|
[**job_templates_list**](JobTemplatesApi.md#job_templates_list) | **GET** /projects/{project_id}/job_templates | List job templates
|
11
|
+
[**job_templates_show**](JobTemplatesApi.md#job_templates_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
|
12
12
|
|
13
13
|
|
14
14
|
|
15
15
|
## job_template_create
|
16
16
|
|
17
|
-
>
|
17
|
+
> JobTemplateDetails job_template_create(project_id, job_template_create_parameters, opts)
|
18
18
|
|
19
19
|
Create a job template
|
20
20
|
|
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
|
|
63
63
|
|
64
64
|
### Return type
|
65
65
|
|
66
|
-
Response<(**
|
66
|
+
Response<([**JobTemplateDetails**](JobTemplateDetails.md))>
|
67
67
|
|
68
68
|
### Authorization
|
69
69
|
|
@@ -139,13 +139,13 @@ Response<(nil (empty response body))>
|
|
139
139
|
- **Accept**: Not defined
|
140
140
|
|
141
141
|
|
142
|
-
##
|
142
|
+
## job_template_update
|
143
143
|
|
144
|
-
>
|
144
|
+
> JobTemplateDetails job_template_update(project_id, id, job_template_update_parameters, opts)
|
145
145
|
|
146
|
-
|
146
|
+
Update a job template
|
147
147
|
|
148
|
-
|
148
|
+
Update an existing job template.
|
149
149
|
|
150
150
|
### Example
|
151
151
|
|
@@ -166,17 +166,17 @@ end
|
|
166
166
|
api_instance = Phrase::JobTemplatesApi.new
|
167
167
|
project_id = 'project_id_example' # String | Project ID
|
168
168
|
id = 'id_example' # String | ID
|
169
|
+
job_template_update_parameters = Phrase::JobTemplateUpdateParameters.new # JobTemplateUpdateParameters |
|
169
170
|
opts = {
|
170
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example'
|
171
|
-
branch: 'my-feature-branch' # String | specify the branch to use
|
171
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
172
172
|
}
|
173
173
|
|
174
174
|
begin
|
175
|
-
#
|
176
|
-
result = api_instance.
|
175
|
+
#Update a job template
|
176
|
+
result = api_instance.job_template_update(project_id, id, job_template_update_parameters, opts)
|
177
177
|
pp result
|
178
178
|
rescue Phrase::ApiError => e
|
179
|
-
puts "Exception when calling JobTemplatesApi->
|
179
|
+
puts "Exception when calling JobTemplatesApi->job_template_update: #{e}"
|
180
180
|
end
|
181
181
|
```
|
182
182
|
|
@@ -187,12 +187,12 @@ Name | Type | Description | Notes
|
|
187
187
|
------------- | ------------- | ------------- | -------------
|
188
188
|
**project_id** | **String**| Project ID |
|
189
189
|
**id** | **String**| ID |
|
190
|
+
**job_template_update_parameters** | [**JobTemplateUpdateParameters**](JobTemplateUpdateParameters.md)| |
|
190
191
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
191
|
-
**branch** | **String**| specify the branch to use | [optional]
|
192
192
|
|
193
193
|
### Return type
|
194
194
|
|
195
|
-
Response<(**
|
195
|
+
Response<([**JobTemplateDetails**](JobTemplateDetails.md))>
|
196
196
|
|
197
197
|
### Authorization
|
198
198
|
|
@@ -200,17 +200,17 @@ Response<(**Object**)>
|
|
200
200
|
|
201
201
|
### HTTP request headers
|
202
202
|
|
203
|
-
- **Content-Type**:
|
203
|
+
- **Content-Type**: application/json
|
204
204
|
- **Accept**: application/json
|
205
205
|
|
206
206
|
|
207
|
-
##
|
207
|
+
## job_templates_list
|
208
208
|
|
209
|
-
>
|
209
|
+
> Array<JobTemplate> job_templates_list(project_id, opts)
|
210
210
|
|
211
|
-
|
211
|
+
List job templates
|
212
212
|
|
213
|
-
|
213
|
+
List all job templates for the given project.
|
214
214
|
|
215
215
|
### Example
|
216
216
|
|
@@ -230,18 +230,19 @@ end
|
|
230
230
|
|
231
231
|
api_instance = Phrase::JobTemplatesApi.new
|
232
232
|
project_id = 'project_id_example' # String | Project ID
|
233
|
-
id = 'id_example' # String | ID
|
234
|
-
job_template_update_parameters = Phrase::JobTemplateUpdateParameters.new # JobTemplateUpdateParameters |
|
235
233
|
opts = {
|
236
|
-
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
234
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
235
|
+
page: 1, # Integer | Page number
|
236
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
237
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
237
238
|
}
|
238
239
|
|
239
240
|
begin
|
240
|
-
#
|
241
|
-
result = api_instance.
|
241
|
+
#List job templates
|
242
|
+
result = api_instance.job_templates_list(project_id, opts)
|
242
243
|
pp result
|
243
244
|
rescue Phrase::ApiError => e
|
244
|
-
puts "Exception when calling JobTemplatesApi->
|
245
|
+
puts "Exception when calling JobTemplatesApi->job_templates_list: #{e}"
|
245
246
|
end
|
246
247
|
```
|
247
248
|
|
@@ -251,13 +252,14 @@ end
|
|
251
252
|
Name | Type | Description | Notes
|
252
253
|
------------- | ------------- | ------------- | -------------
|
253
254
|
**project_id** | **String**| Project ID |
|
254
|
-
**id** | **String**| ID |
|
255
|
-
**job_template_update_parameters** | [**JobTemplateUpdateParameters**](JobTemplateUpdateParameters.md)| |
|
256
255
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
256
|
+
**page** | **Integer**| Page number | [optional]
|
257
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
258
|
+
**branch** | **String**| specify the branch to use | [optional]
|
257
259
|
|
258
260
|
### Return type
|
259
261
|
|
260
|
-
Response<(**
|
262
|
+
Response<([**Array<JobTemplate>**](JobTemplate.md))>
|
261
263
|
|
262
264
|
### Authorization
|
263
265
|
|
@@ -265,17 +267,17 @@ Response<(**Object**)>
|
|
265
267
|
|
266
268
|
### HTTP request headers
|
267
269
|
|
268
|
-
- **Content-Type**:
|
270
|
+
- **Content-Type**: Not defined
|
269
271
|
- **Accept**: application/json
|
270
272
|
|
271
273
|
|
272
|
-
##
|
274
|
+
## job_templates_show
|
273
275
|
|
274
|
-
>
|
276
|
+
> JobTemplateDetails job_templates_show(project_id, id, opts)
|
275
277
|
|
276
|
-
|
278
|
+
Get a single job template
|
277
279
|
|
278
|
-
|
280
|
+
Get details on a single job template for a given project.
|
279
281
|
|
280
282
|
### Example
|
281
283
|
|
@@ -295,19 +297,18 @@ end
|
|
295
297
|
|
296
298
|
api_instance = Phrase::JobTemplatesApi.new
|
297
299
|
project_id = 'project_id_example' # String | Project ID
|
300
|
+
id = 'id_example' # String | ID
|
298
301
|
opts = {
|
299
302
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
300
|
-
page: 1, # Integer | Page number
|
301
|
-
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
302
303
|
branch: 'my-feature-branch' # String | specify the branch to use
|
303
304
|
}
|
304
305
|
|
305
306
|
begin
|
306
|
-
#
|
307
|
-
result = api_instance.
|
307
|
+
#Get a single job template
|
308
|
+
result = api_instance.job_templates_show(project_id, id, opts)
|
308
309
|
pp result
|
309
310
|
rescue Phrase::ApiError => e
|
310
|
-
puts "Exception when calling JobTemplatesApi->
|
311
|
+
puts "Exception when calling JobTemplatesApi->job_templates_show: #{e}"
|
311
312
|
end
|
312
313
|
```
|
313
314
|
|
@@ -317,14 +318,13 @@ end
|
|
317
318
|
Name | Type | Description | Notes
|
318
319
|
------------- | ------------- | ------------- | -------------
|
319
320
|
**project_id** | **String**| Project ID |
|
321
|
+
**id** | **String**| ID |
|
320
322
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
321
|
-
**page** | **Integer**| Page number | [optional]
|
322
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
323
323
|
**branch** | **String**| specify the branch to use | [optional]
|
324
324
|
|
325
325
|
### Return type
|
326
326
|
|
327
|
-
Response<([**
|
327
|
+
Response<([**JobTemplateDetails**](JobTemplateDetails.md))>
|
328
328
|
|
329
329
|
### Authorization
|
330
330
|
|
data/docs/JobsApi.md
CHANGED
@@ -760,7 +760,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
760
760
|
opts = {
|
761
761
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
762
762
|
page: 1, # Integer | Page number
|
763
|
-
per_page: 25, # Integer |
|
763
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
764
764
|
owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
|
765
765
|
assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
|
766
766
|
state: 'completed' # String | filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>
|
@@ -783,7 +783,7 @@ Name | Type | Description | Notes
|
|
783
783
|
**account_id** | **String**| Account ID |
|
784
784
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
785
785
|
**page** | **Integer**| Page number | [optional]
|
786
|
-
**per_page** | **Integer**|
|
786
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
787
787
|
**owned_by** | **String**| filter by user owning job | [optional]
|
788
788
|
**assigned_to** | **String**| filter by user assigned to job | [optional]
|
789
789
|
**state** | **String**| filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code> | [optional]
|
@@ -831,7 +831,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
831
831
|
opts = {
|
832
832
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
833
833
|
page: 1, # Integer | Page number
|
834
|
-
per_page: 25, # Integer |
|
834
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
835
835
|
branch: 'my-feature-branch', # String | specify the branch to use
|
836
836
|
owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
|
837
837
|
assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
|
@@ -855,7 +855,7 @@ Name | Type | Description | Notes
|
|
855
855
|
**project_id** | **String**| Project ID |
|
856
856
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
857
857
|
**page** | **Integer**| Page number | [optional]
|
858
|
-
**per_page** | **Integer**|
|
858
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
859
859
|
**branch** | **String**| specify the branch to use | [optional]
|
860
860
|
**owned_by** | **String**| filter by user owning job | [optional]
|
861
861
|
**assigned_to** | **String**| filter by user assigned to job | [optional]
|
data/docs/KeysApi.md
CHANGED
@@ -497,7 +497,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
497
497
|
opts = {
|
498
498
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
499
499
|
page: 1, # Integer | Page number
|
500
|
-
per_page: 25, # Integer |
|
500
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
501
501
|
branch: 'my-feature-branch', # String | specify the branch to use
|
502
502
|
sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
|
503
503
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
@@ -522,7 +522,7 @@ Name | Type | Description | Notes
|
|
522
522
|
**project_id** | **String**| Project ID |
|
523
523
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
524
524
|
**page** | **Integer**| Page number | [optional]
|
525
|
-
**per_page** | **Integer**|
|
525
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
526
526
|
**branch** | **String**| specify the branch to use | [optional]
|
527
527
|
**sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional]
|
528
528
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
@@ -573,7 +573,7 @@ keys_search_parameters = Phrase::KeysSearchParameters.new # KeysSearchParameters
|
|
573
573
|
opts = {
|
574
574
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
575
575
|
page: 1, # Integer | Page number
|
576
|
-
per_page: 25 # Integer |
|
576
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
577
577
|
}
|
578
578
|
|
579
579
|
begin
|
@@ -594,7 +594,7 @@ Name | Type | Description | Notes
|
|
594
594
|
**keys_search_parameters** | [**KeysSearchParameters**](KeysSearchParameters.md)| |
|
595
595
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
596
596
|
**page** | **Integer**| Page number | [optional]
|
597
|
-
**per_page** | **Integer**|
|
597
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
598
598
|
|
599
599
|
### Return type
|
600
600
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
8
|
**sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional]
|
9
9
|
**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
|
10
|
-
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. | [optional]
|
10
|
+
**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. | [optional]
|
11
11
|
**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
|
12
12
|
|
13
13
|
## Code Sample
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Phrase::LocaleTeamPreview
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**role** | **String** | | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'Phrase'
|
15
|
+
|
16
|
+
instance = Phrase::LocaleTeamPreview.new(id: null,
|
17
|
+
name: null,
|
18
|
+
role: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Phrase::
|
1
|
+
# Phrase::LocaleUserPreview
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
14
14
|
```ruby
|
15
15
|
require 'Phrase'
|
16
16
|
|
17
|
-
instance = Phrase::
|
17
|
+
instance = Phrase::LocaleUserPreview.new(id: null,
|
18
18
|
username: null,
|
19
19
|
name: null,
|
20
20
|
role: null)
|
data/docs/LocalesApi.md
CHANGED
@@ -43,7 +43,7 @@ id = 'id_example' # String | ID
|
|
43
43
|
opts = {
|
44
44
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
45
45
|
page: 1, # Integer | Page number
|
46
|
-
per_page: 25 # Integer |
|
46
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
47
47
|
}
|
48
48
|
|
49
49
|
begin
|
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
|
|
63
63
|
**id** | **String**| ID |
|
64
64
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
65
65
|
**page** | **Integer**| Page number | [optional]
|
66
|
-
**per_page** | **Integer**|
|
66
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
67
67
|
|
68
68
|
### Return type
|
69
69
|
|
@@ -235,8 +235,10 @@ project_id = 'project_id_example' # String | Project ID
|
|
235
235
|
id = 'id_example' # String | ID
|
236
236
|
opts = {
|
237
237
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
238
|
+
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)
|
239
|
+
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)
|
238
240
|
branch: 'my-feature-branch', # String | specify the branch to use
|
239
|
-
file_format: 'yml', # String | File format name. See the <a href=\"https://support.phrase.com/hc/en-us/
|
241
|
+
file_format: 'yml', # 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.
|
240
242
|
tags: 'feature1,feature2', # String | Limit results to keys tagged with a list of comma separated tag names.
|
241
243
|
tag: 'feature', # String | Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
|
242
244
|
include_empty_translations: true, # Boolean | Indicates whether keys without translations should be included in the output as well.
|
@@ -244,7 +246,7 @@ opts = {
|
|
244
246
|
include_translated_keys: true, # Boolean | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
|
245
247
|
keep_notranslate_tags: true, # Boolean | Indicates whether [NOTRANSLATE] tags should be kept.
|
246
248
|
convert_emoji: true, # Boolean | This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
|
247
|
-
format_options: nil, # Object | Additional formatting and render options. See the <a href=\"https://support.phrase.com/hc/en-us/
|
249
|
+
format_options: nil, # 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>
|
248
250
|
encoding: 'encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
|
249
251
|
skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
|
250
252
|
include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
|
@@ -270,8 +272,10 @@ Name | Type | Description | Notes
|
|
270
272
|
**project_id** | **String**| Project ID |
|
271
273
|
**id** | **String**| ID |
|
272
274
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
275
|
+
**if_modified_since** | **String**| Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
276
|
+
**if_none_match** | **String**| ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional) | [optional]
|
273
277
|
**branch** | **String**| specify the branch to use | [optional]
|
274
|
-
**file_format** | **String**| File format name. See the <a href=\"https://support.phrase.com/hc/en-us/
|
278
|
+
**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. | [optional]
|
275
279
|
**tags** | **String**| Limit results to keys tagged with a list of comma separated tag names. | [optional]
|
276
280
|
**tag** | **String**| Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead | [optional]
|
277
281
|
**include_empty_translations** | **Boolean**| Indicates whether keys without translations should be included in the output as well. | [optional]
|
@@ -279,7 +283,7 @@ Name | Type | Description | Notes
|
|
279
283
|
**include_translated_keys** | **Boolean**| Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional]
|
280
284
|
**keep_notranslate_tags** | **Boolean**| Indicates whether [NOTRANSLATE] tags should be kept. | [optional]
|
281
285
|
**convert_emoji** | **Boolean**| This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively. | [optional]
|
282
|
-
**format_options** | [**Object**](.md)| Additional formatting and render options. See the <a href=\"https://support.phrase.com/hc/en-us/
|
286
|
+
**format_options** | [**Object**](.md)| 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]
|
283
287
|
**encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | [optional]
|
284
288
|
**skip_unverified_translations** | **Boolean**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>. | [optional]
|
285
289
|
**include_unverified_translations** | **Boolean**| if set to false unverified translations are excluded | [optional]
|
@@ -460,7 +464,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
460
464
|
opts = {
|
461
465
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
462
466
|
page: 1, # Integer | Page number
|
463
|
-
per_page: 25, # Integer |
|
467
|
+
per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
464
468
|
sort_by: 'sort_by_example', # String | Sort locales. Valid options are \"name_asc\", \"name_desc\", \"default_asc\", \"default_desc\".
|
465
469
|
branch: 'my-feature-branch' # String | specify the branch to use
|
466
470
|
}
|
@@ -482,7 +486,7 @@ Name | Type | Description | Notes
|
|
482
486
|
**project_id** | **String**| Project ID |
|
483
487
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
484
488
|
**page** | **Integer**| Page number | [optional]
|
485
|
-
**per_page** | **Integer**|
|
489
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
486
490
|
**sort_by** | **String**| Sort locales. Valid options are \"name_asc\", \"name_desc\", \"default_asc\", \"default_desc\". | [optional]
|
487
491
|
**branch** | **String**| specify the branch to use | [optional]
|
488
492
|
|
data/docs/MembersApi.md
CHANGED
@@ -296,7 +296,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
296
296
|
opts = {
|
297
297
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
298
298
|
page: 1, # Integer | Page number
|
299
|
-
per_page: 25 # Integer |
|
299
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
300
300
|
}
|
301
301
|
|
302
302
|
begin
|
@@ -316,7 +316,7 @@ Name | Type | Description | Notes
|
|
316
316
|
**account_id** | **String**| Account ID |
|
317
317
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
318
318
|
**page** | **Integer**| Page number | [optional]
|
319
|
-
**per_page** | **Integer**|
|
319
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
320
320
|
|
321
321
|
### Return type
|
322
322
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**created_at** | **DateTime** | | [optional]
|
10
10
|
**updated_at** | **DateTime** | | [optional]
|
11
11
|
**notifications_count** | **Integer** | | [optional]
|
12
|
-
**latest_notification** | **
|
12
|
+
**latest_notification** | [**Notification**](Notification.md) | | [optional]
|
13
13
|
|
14
14
|
## Code Sample
|
15
15
|
|
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
12
12
|
|
13
13
|
## notification_groups_list
|
14
14
|
|
15
|
-
> Array<
|
15
|
+
> Array<NotificationGroupDetail> notification_groups_list(opts)
|
16
16
|
|
17
17
|
List notification groups
|
18
18
|
|
@@ -38,7 +38,7 @@ api_instance = Phrase::NotificationGroupsApi.new
|
|
38
38
|
opts = {
|
39
39
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
40
40
|
page: 1, # Integer | Page number
|
41
|
-
per_page: 25 # Integer |
|
41
|
+
per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
42
42
|
}
|
43
43
|
|
44
44
|
begin
|
@@ -57,11 +57,11 @@ Name | Type | Description | Notes
|
|
57
57
|
------------- | ------------- | ------------- | -------------
|
58
58
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
59
59
|
**page** | **Integer**| Page number | [optional]
|
60
|
-
**per_page** | **Integer**|
|
60
|
+
**per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
|
61
61
|
|
62
62
|
### Return type
|
63
63
|
|
64
|
-
Response<(**Array<
|
64
|
+
Response<([**Array<NotificationGroupDetail>**](NotificationGroupDetail.md))>
|
65
65
|
|
66
66
|
### Authorization
|
67
67
|
|
@@ -75,7 +75,7 @@ Response<(**Array<Object>**)>
|
|
75
75
|
|
76
76
|
## notification_groups_mark_all_as_read
|
77
77
|
|
78
|
-
> Array<
|
78
|
+
> Array<NotificationGroupDetail> notification_groups_mark_all_as_read(opts)
|
79
79
|
|
80
80
|
Mark all notification groups as read
|
81
81
|
|
@@ -120,7 +120,7 @@ Name | Type | Description | Notes
|
|
120
120
|
|
121
121
|
### Return type
|
122
122
|
|
123
|
-
Response<(**Array<
|
123
|
+
Response<([**Array<NotificationGroupDetail>**](NotificationGroupDetail.md))>
|
124
124
|
|
125
125
|
### Authorization
|
126
126
|
|