phrase 4.28.0 → 4.30.0

data/docs/MembersApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**member_show**](MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
 [**member_update**](MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
 [**member_update_settings**](MembersApi.md#member_update_settings) | **PATCH** /projects/{project_id}/members/{id} | Update a member's project settings
+[**members_by_project**](MembersApi.md#members_by_project) | **GET** /projects/{project_id}/members | List project members
 [**members_list**](MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
 
 
@@ -267,6 +268,75 @@ Response<([**MemberProjectDetail**](MemberProjectDetail.md))>
 - **Accept**: application/json
 
 
+## members_by_project
+
+> Array&lt;ProjectMember&gt; members_by_project(project_id, opts)
+
+List project members
+
+Get all members active in the project. Access token scope must include `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::MembersApi.new
+project_id = 'project_id_example' # String | Project ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  q: 'jane*', # String | Specify a query to search for members by name or email (including wildcards).
+  job_id: 'abcd1234cdef1234abcd1234cdef1234', # String | Filter members to those assigned to the job identified by this id.
+  page: 1, # Integer | Page number
+  per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
+}
+
+begin
+  #List project members
+  result = api_instance.members_by_project(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling MembersApi->members_by_project: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **q** | **String**| Specify a query to search for members by name or email (including wildcards). | [optional] 
+ **job_id** | **String**| Filter members to those assigned to the job identified by this id. | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
+
+### Return type
+
+Response<([**Array&lt;ProjectMember&gt;**](ProjectMember.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## members_list
 
 > Array&lt;Member&gt; members_list(account_id, opts)

data/docs/Notification.md

@@ -21,21 +21,21 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+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)
+instance = Phrase::Notification.new(id: nil,
+                                 event_name: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 delivered_at: nil,
+                                 seen_at: nil,
+                                 data: nil,
+                                 resource: nil,
+                                 locale: nil,
+                                 user: nil,
+                                 project: nil,
+                                 account: nil,
+                                 group: nil)
 ```
 
 

data/docs/NotificationGroup.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::NotificationGroup.new(id: null,
-                                 event_name: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::NotificationGroup.new(id: nil,
+                                 event_name: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/NotificationGroupDetail.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::NotificationGroupDetail.new(id: null,
-                                 event_name: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 notifications_count: null,
-                                 latest_notification: null)
+instance = Phrase::NotificationGroupDetail.new(id: nil,
+                                 event_name: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 notifications_count: nil,
+                                 latest_notification: nil)
 ```
 
 

data/docs/OrderConfirmParameters.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::OrderConfirmParameters.new(branch: my-feature-branch)
+instance = Phrase::OrderConfirmParameters.new(branch: 'my-feature-branch')
 ```
 
 

data/docs/OrderCreateParameters.md

@@ -23,23 +23,23 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::OrderCreateParameters.new(branch: my-feature-branch,
-                                 name: Welcome message translations,
-                                 lsp: textmaster,
-                                 source_locale_id: abcd1234abcd1234abcd1234abcd1234,
-                                 target_locale_ids: ["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"],
-                                 translation_type: premium,
-                                 tag: my-awesome-feature,
-                                 message: Please make everything sound really nice :),
-                                 styleguide_id: 1234abcd1234abcd1234abcd1234abcd,
-                                 unverify_translations_upon_delivery: null,
-                                 include_untranslated_keys: null,
-                                 include_unverified_translations: null,
-                                 category: C021,
-                                 quality: null,
-                                 priority: null)
+instance = Phrase::OrderCreateParameters.new(branch: 'my-feature-branch',
+                                 name: 'Welcome message translations',
+                                 lsp: 'textmaster',
+                                 source_locale_id: 'abcd1234abcd1234abcd1234abcd1234',
+                                 target_locale_ids: ["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"],
+                                 translation_type: 'premium',
+                                 tag: 'my-awesome-feature',
+                                 message: 'Please make everything sound really nice :)',
+                                 styleguide_id: '1234abcd1234abcd1234abcd1234abcd',
+                                 unverify_translations_upon_delivery: nil,
+                                 include_untranslated_keys: nil,
+                                 include_unverified_translations: nil,
+                                 category: 'C021',
+                                 quality: nil,
+                                 priority: nil)
 ```
 
 

data/docs/OrganizationJobTemplate.md

@@ -15,15 +15,15 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::OrganizationJobTemplate.new(id: null,
-                                 name: null,
-                                 briefing: null,
-                                 autotranslate_enabled: null,
-                                 source_locale_id: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::OrganizationJobTemplate.new(id: nil,
+                                 name: nil,
+                                 briefing: nil,
+                                 autotranslate_enabled: nil,
+                                 source_locale_id: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/OrganizationJobTemplateCreateParameters.md

@@ -7,15 +7,17 @@ Name | Type | Description | Notes
 **name** | **String** | Job template name | 
 **briefing** | **String** | Briefing for the translators | [optional] 
 **autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional] 
+**owner_id** | **String** | Code of the account member to set as the job template owner. When omitted or blank, no owner is pre-set; the user who creates a job from this template is assigned as its owner at job-creation time.  | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::OrganizationJobTemplateCreateParameters.new(name: template,
-                                 briefing: text,
-                                 autotranslate: true)
+instance = Phrase::OrganizationJobTemplateCreateParameters.new(name: 'template',
+                                 briefing: 'text',
+                                 autotranslate: true,
+                                 owner_id: nil)
 ```
 
 

data/docs/OrganizationJobTemplateDetails.md

@@ -18,18 +18,18 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::OrganizationJobTemplateDetails.new(id: null,
-                                 name: null,
-                                 briefing: null,
-                                 autotranslate_enabled: null,
-                                 source_locale_id: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 owner: null,
-                                 creator: null,
-                                 locales: null)
+instance = Phrase::OrganizationJobTemplateDetails.new(id: nil,
+                                 name: nil,
+                                 briefing: nil,
+                                 autotranslate_enabled: nil,
+                                 source_locale_id: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 owner: nil,
+                                 creator: nil,
+                                 locales: nil)
 ```
 
 

data/docs/OrganizationJobTemplateLocaleUpdateParameters.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::OrganizationJobTemplateLocaleUpdateParameters.new(locale_name: de-1,
-                                 locale_code: de-DE,
-                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+instance = Phrase::OrganizationJobTemplateLocaleUpdateParameters.new(locale_name: 'de-1',
+                                 locale_code: 'de-DE',
+                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
 ```
 
 

data/docs/OrganizationJobTemplateLocalesCreateParameters.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::OrganizationJobTemplateLocalesCreateParameters.new(locale_name: de-1,
-                                 locale_code: de-DE,
-                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+instance = Phrase::OrganizationJobTemplateLocalesCreateParameters.new(locale_name: 'de-1',
+                                 locale_code: 'de-DE',
+                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
 ```
 
 

data/docs/OrganizationJobTemplateUpdateParameters.md

@@ -7,15 +7,17 @@ Name | Type | Description | Notes
 **name** | **String** | Job template name | 
 **briefing** | **String** | Briefing for the translators | [optional] 
 **autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional] 
+**owner_id** | **String** | Code of the account member to set as the job template owner. Pass an empty string to clear a previously set owner; when blank, the owner is set to null and jobs created from this template will default to assigning the job creator as owner.  | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::OrganizationJobTemplateUpdateParameters.new(name: template,
-                                 briefing: text,
-                                 autotranslate: true)
+instance = Phrase::OrganizationJobTemplateUpdateParameters.new(name: 'template',
+                                 briefing: 'text',
+                                 autotranslate: true,
+                                 owner_id: nil)
 ```
 
 

data/docs/PreTranslation.md

@@ -15,15 +15,15 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::PreTranslation.new(id: abcd1234cdef1234abcd1234cdef1234,
-                                 status: null,
-                                 translatable_type: null,
-                                 translatable_id: abcd1234cdef1234abcd1234cdef1234,
-                                 error: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::PreTranslation.new(id: 'abcd1234cdef1234abcd1234cdef1234',
+                                 status: nil,
+                                 translatable_type: nil,
+                                 translatable_id: 'abcd1234cdef1234abcd1234cdef1234',
+                                 error: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/PreTranslationCreateParameters.md

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::PreTranslationCreateParameters.new(translatable_type: null,
-                                 translatable_id: null)
+instance = Phrase::PreTranslationCreateParameters.new(translatable_type: nil,
+                                 translatable_id: nil)
 ```
 
 

data/docs/Project.md

@@ -19,19 +19,19 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::Project.new(id: null,
-                                 name: null,
-                                 slug: null,
-                                 main_format: null,
-                                 project_image_url: null,
-                                 media: null,
-                                 account: null,
-                                 space: null,
-                                 point_of_contact: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::Project.new(id: nil,
+                                 name: nil,
+                                 slug: nil,
+                                 main_format: nil,
+                                 project_image_url: nil,
+                                 media: nil,
+                                 account: nil,
+                                 space: nil,
+                                 point_of_contact: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/ProjectCreateParameters.md

@@ -44,20 +44,20 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
-                                 main_format: yml,
-                                 media: Python,
+instance = Phrase::ProjectCreateParameters.new(name: 'My Android Project',
+                                 main_format: 'yml',
+                                 media: 'Python',
                                  shares_translation_memory: true,
-                                 tm_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 term_base_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 project_image: [B@104d07a8,
-                                 remove_project_image: null,
-                                 account_id: abcd1234,
-                                 point_of_contact: abcd1234,
-                                 source_project_id: abcd1234,
-                                 workflow: review,
+                                 tm_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 term_base_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 project_image: File.new('/path/to/file'),
+                                 remove_project_image: nil,
+                                 account_id: 'abcd1234',
+                                 point_of_contact: 'abcd1234',
+                                 source_project_id: 'abcd1234',
+                                 workflow: 'review',
                                  machine_translation_enabled: true,
                                  enable_branching: true,
                                  protect_master_branch: true,
@@ -78,10 +78,10 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
                                  smart_suggest_enabled: true,
                                  smart_suggest_use_glossary: true,
                                  smart_suggest_use_machine_translation: true,
-                                 translation_keys_sort_collation: unicode_ci,
-                                 default_encoding: UTF-8,
-                                 cldr_version: cldr48,
-                                 placeholder_styles: ["rails_i18n","java_properties"])
+                                 translation_keys_sort_collation: 'unicode_ci',
+                                 default_encoding: 'UTF-8',
+                                 cldr_version: 'cldr48',
+                                 placeholder_styles: ["rails_i18n","java_properties"])
 ```
 
 

data/docs/ProjectDetails.md

@@ -42,20 +42,20 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ProjectDetails.new(id: null,
-                                 name: null,
-                                 slug: null,
-                                 main_format: null,
-                                 project_image_url: null,
-                                 media: null,
-                                 account: null,
-                                 space: null,
-                                 point_of_contact: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 shares_translation_memory: null,
+instance = Phrase::ProjectDetails.new(id: nil,
+                                 name: nil,
+                                 slug: nil,
+                                 main_format: nil,
+                                 project_image_url: nil,
+                                 media: nil,
+                                 account: nil,
+                                 space: nil,
+                                 point_of_contact: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 shares_translation_memory: nil,
                                  machine_translation_enabled: true,
                                  zero_plural_form_enabled: true,
                                  enable_all_data_type_translation_keys_for_translators: false,
@@ -72,12 +72,12 @@ instance = Phrase::ProjectDetails.new(id: null,
                                  autotranslate_overwrite_unverified_translations: false,
                                  fallback_for_unverified_translations: false,
                                  autocomplete_job_enabled: false,
-                                 default_encoding: UTF-8,
-                                 cldr_version: legacy,
-                                 translation_keys_sort_collation: unicode_ci,
+                                 default_encoding: 'UTF-8',
+                                 cldr_version: 'legacy',
+                                 translation_keys_sort_collation: 'unicode_ci',
                                  job_locking_enabled: false,
-                                 placeholder_styles: ["rails_i18n","java_properties"],
-                                 branch: null)
+                                 placeholder_styles: ["rails_i18n","java_properties"],
+                                 branch: nil)
 ```
 
 

data/docs/ProjectLocales.md

@@ -15,15 +15,15 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ProjectLocales.new(id: null,
-                                 name: null,
-                                 project_role: null,
-                                 main_format: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 locales: null)
+instance = Phrase::ProjectLocales.new(id: nil,
+                                 name: nil,
+                                 project_role: nil,
+                                 main_format: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 locales: nil)
 ```
 
 

data/docs/ProjectMember.md

@@ -0,0 +1,27 @@
+# Phrase::ProjectMember
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**username** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**position** | **String** |  | [optional] 
+**created_at** | **Time** |  | [optional] 
+**updated_at** | **Time** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'phrase'
+
+instance = Phrase::ProjectMember.new(id: nil,
+                                 username: nil,
+                                 name: nil,
+                                 position: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
+```
+
+

data/docs/ProjectReport.md

@@ -16,16 +16,16 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ProjectReport.new(locales_count: null,
-                                 keys_count: null,
-                                 translations_count: null,
-                                 untranslated_keys_count: null,
-                                 unverified_translations_count: null,
-                                 reviewed_translations_count: null,
-                                 managed_words_count: null,
-                                 project: null)
+instance = Phrase::ProjectReport.new(locales_count: nil,
+                                 keys_count: nil,
+                                 translations_count: nil,
+                                 untranslated_keys_count: nil,
+                                 unverified_translations_count: nil,
+                                 reviewed_translations_count: nil,
+                                 managed_words_count: nil,
+                                 project: nil)
 ```
 
 

data/docs/ProjectShort.md

@@ -13,13 +13,13 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ProjectShort.new(id: null,
-                                 name: null,
-                                 main_format: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::ProjectShort.new(id: nil,
+                                 name: nil,
+                                 main_format: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```