phrase 2.0.0 → 2.3.1

data/docs/KeysExcludeParameters.md

@@ -0,0 +1,23 @@
+# Phrase::KeysExcludeParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**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] 
+**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional] 
+**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysExcludeParameters.new(branch: my-feature-branch,
+                                 q: mykey* translated:true,
+                                 target_locale_id: abcd1234abcd1234abcd1234abcd1234,
+                                 tags: landing-page,release-1.2)
+```
+
+

data/docs/KeysIncludeParameters.md

@@ -0,0 +1,23 @@
+# Phrase::KeysIncludeParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**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] 
+**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional] 
+**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysIncludeParameters.new(branch: my-feature-branch,
+                                 q: mykey* translated:true,
+                                 target_locale_id: abcd1234abcd1234abcd1234abcd1234,
+                                 tags: landing-page,release-1.2)
+```
+
+

data/docs/KeysSearchParameters.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **branch** | **String** | specify the branch to use | [optional] 
 **sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional] 
 **order** | **String** | Order direction. Can be one of: asc, desc. | [optional] 
-**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 - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</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] 
+**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] 
 **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
 
 ## Code Sample

data/docs/KeysTagParameters.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [optional] 
-**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 - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</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] 
+**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] 
 **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
 **tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional] 
 

data/docs/KeysUntagParameters.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [optional] 
-**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 - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</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] 
+**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] 
 **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
 **tags** | **String** | Tag or comma-separated list of tags to remove from the matching collection of keys | [optional] 
 

data/docs/LocalePreview1.md

@@ -0,0 +1,23 @@
+# Phrase::LocalePreview1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**code** | **String** |  | [optional] 
+**project** | [**ProjectShort**](ProjectShort.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocalePreview1.new(id: null,
+                                 name: null,
+                                 code: null,
+                                 project: null)
+```
+
+

data/docs/LocalesApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.phrase.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**account_locales**](LocalesApi.md#account_locales) | **GET** /accounts/{account_id}/locales | List locales used in account
 [**locale_create**](LocalesApi.md#locale_create) | **POST** /projects/{project_id}/locales | Create a locale
 [**locale_delete**](LocalesApi.md#locale_delete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale
 [**locale_download**](LocalesApi.md#locale_download) | **GET** /projects/{project_id}/locales/{id}/download | Download a locale
@@ -13,6 +14,71 @@ Method | HTTP request | Description
 
 
 
+## account_locales
+
+> Array<LocalePreview1> account_locales(id, opts)
+
+List locales used in account
+
+List all locales unique by locale code used across all projects within an account.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::LocalesApi.new
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  page: 1, # Integer | Page number
+  per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
+}
+
+begin
+  #List locales used in account
+  result = api_instance.account_locales(id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling LocalesApi->account_locales: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
+
+### Return type
+
+Response<([**Array&lt;LocalePreview1&gt;**](LocalePreview1.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## locale_create
 
 > LocaleDetails locale_create(project_id, locale_create_parameters, opts)
@@ -170,7 +236,7 @@ id = 'id_example' # String | ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   branch: 'my-feature-branch', # String | specify the branch to use
-  file_format: 'yml', # String | File format name. See the format guide for all supported file formats.
+  file_format: 'yml', # String | File format name. See the <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">format guide</a> for all supported file formats.
   tags: 'feature1,feature2', # String | Limit results to keys tagged with a list of comma separated tag names.
   tag: 'feature', # String | Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
   include_empty_translations: true, # Boolean | Indicates whether keys without translations should be included in the output as well.
@@ -183,7 +249,8 @@ opts = {
   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>.
   include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
   use_last_reviewed_version: true, # Boolean | If set to true the last reviewed version of a translation is used. This is only available if the review workflow (currently in beta) is enabled for the project.
-  fallback_locale_id: 'fallback_locale_id_example' # String | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
+  fallback_locale_id: 'fallback_locale_id_example', # String | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
+  source_locale_id: 'source_locale_id_example' # 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.
 }
 
 begin
@@ -204,7 +271,7 @@ Name | Type | Description  | Notes
  **id** | **String**| ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **branch** | **String**| specify the branch to use | [optional] 
- **file_format** | **String**| File format name. See the format guide for all supported file formats. | [optional] 
+ **file_format** | **String**| File format name. See the &lt;a href&#x3D;\&quot;https://help.phrase.com/help/supported-platforms-and-formats\&quot;&gt;format guide&lt;/a&gt; for all supported file formats. | [optional] 
  **tags** | **String**| Limit results to keys tagged with a list of comma separated tag names. | [optional] 
  **tag** | **String**| Limit download to tagged keys. This parameter is deprecated. Please use the \&quot;tags\&quot; parameter instead | [optional] 
  **include_empty_translations** | **Boolean**| Indicates whether keys without translations should be included in the output as well. | [optional] 
@@ -218,6 +285,7 @@ Name | Type | Description  | Notes
  **include_unverified_translations** | **Boolean**| if set to false unverified translations are excluded | [optional] 
  **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 (currently in beta) is enabled for the project. | [optional] 
  **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 public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to &lt;code&gt;true&lt;/code&gt;. | [optional] 
+ **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 &lt;code&gt;tag&lt;/code&gt; parameter indicating a specific job. | [optional] 
 
 ### Return type
 
@@ -393,6 +461,7 @@ opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   page: 1, # Integer | Page number
   per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
+  sort_by: 'sort_by_example', # String | Sort locales. Valid options are \"name_asc\", \"name_desc\", \"default_asc\", \"default_desc\".
   branch: 'my-feature-branch' # String | specify the branch to use
 }
 
@@ -414,6 +483,7 @@ Name | Type | Description  | Notes
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
  **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
+ **sort_by** | **String**| Sort locales. Valid options are \&quot;name_asc\&quot;, \&quot;name_desc\&quot;, \&quot;default_asc\&quot;, \&quot;default_desc\&quot;. | [optional] 
  **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type

data/docs/MemberSpaces.md

@@ -6,8 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
-**created_at** | [**AnyType**](.md) |  | [optional] 
-**updated_at** | [**AnyType**](.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
 **projects_count** | **Integer** |  | [optional] 
 
 ## Code Sample

data/docs/MemberUpdateParameters.md

@@ -4,7 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**role** | **String** | Member role, can be any of of Manager, Developer, Translator | [optional] 
+**strategy** | **String** | Update strategy, can be any of set, add, remove. If provided, it will set, add or remove given spaces, projects and locale ids from users access list. | [optional] 
+**role** | **String** | Member role, can be any of of Admin, ProjectManager, Developer, Designer, Translator | [optional] 
 **project_ids** | **String** | List of project ids the user has access to.  | [optional] 
 **locale_ids** | **String** | List of locale ids the user has access to. | [optional] 
 **default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional] 
@@ -16,7 +17,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::MemberUpdateParameters.new(role: Developer,
+instance = Phrase::MemberUpdateParameters.new(strategy: set,
+                                 role: Developer,
                                  project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
                                  locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
                                  default_locale_codes: ["en","fi"],

data/docs/Notification.md

@@ -0,0 +1,41 @@
+# Phrase::Notification
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**event_name** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**delivered_at** | **DateTime** |  | [optional] 
+**seen_at** | **DateTime** |  | [optional] 
+**data** | [**Object**](.md) |  | [optional] 
+**resource** | [**Object**](.md) |  | [optional] 
+**locale** | [**Locale**](Locale.md) |  | [optional] 
+**user** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**project** | [**Project**](Project.md) |  | [optional] 
+**account** | [**Account**](Account.md) |  | [optional] 
+**group** | [**NotificationGroup**](NotificationGroup.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Notification.new(id: null,
+                                 event_name: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 delivered_at: null,
+                                 seen_at: null,
+                                 data: null,
+                                 resource: null,
+                                 locale: null,
+                                 user: null,
+                                 project: null,
+                                 account: null,
+                                 group: null)
+```
+
+

data/docs/NotificationGroup.md

@@ -0,0 +1,23 @@
+# Phrase::NotificationGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**event_name** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::NotificationGroup.new(id: null,
+                                 event_name: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/NotificationGroupDetail.md

@@ -0,0 +1,27 @@
+# Phrase::NotificationGroupDetail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**event_name** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**notifications_count** | **Integer** |  | [optional] 
+**latest_notification** | **Object** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::NotificationGroupDetail.new(id: null,
+                                 event_name: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 notifications_count: null,
+                                 latest_notification: null)
+```
+
+

data/docs/NotificationGroupsApi.md

@@ -0,0 +1,194 @@
+# Phrase::NotificationGroupsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**notification_groups_list**](NotificationGroupsApi.md#notification_groups_list) | **GET** /notification_groups | List notification groups
+[**notification_groups_mark_all_as_read**](NotificationGroupsApi.md#notification_groups_mark_all_as_read) | **PATCH** /notification_groups/mark_all_as_read | Mark all notification groups as read
+[**notification_groups_mark_as_read**](NotificationGroupsApi.md#notification_groups_mark_as_read) | **PATCH** /notification_groups/{id}/mark_as_read | Mark a notification group as read
+
+
+
+## notification_groups_list
+
+> Array<Object> notification_groups_list(opts)
+
+List notification groups
+
+List all notification groups from the current user
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::NotificationGroupsApi.new
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  page: 1, # Integer | Page number
+  per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
+}
+
+begin
+  #List notification groups
+  result = api_instance.notification_groups_list(opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling NotificationGroupsApi->notification_groups_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
+
+### Return type
+
+Response<(**Array&lt;Object&gt;**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## notification_groups_mark_all_as_read
+
+> Array&lt;Object&gt; notification_groups_mark_all_as_read(opts)
+
+Mark all notification groups as read
+
+Mark all notification groups of the current user as read
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::NotificationGroupsApi.new
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Mark all notification groups as read
+  result = api_instance.notification_groups_mark_all_as_read(opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling NotificationGroupsApi->notification_groups_mark_all_as_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<(**Array&lt;Object&gt;**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## notification_groups_mark_as_read
+
+> NotificationGroupDetail notification_groups_mark_as_read(id, opts)
+
+Mark a notification group as read
+
+Mark a notifications group of the current user as read
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::NotificationGroupsApi.new
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Mark a notification group as read
+  result = api_instance.notification_groups_mark_as_read(id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling NotificationGroupsApi->notification_groups_mark_as_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**NotificationGroupDetail**](NotificationGroupDetail.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+