phrase 4.29.0 → 4.30.0

data/docs/ReleasePreview.md

@@ -20,20 +20,20 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ReleasePreview.new(id: null,
-                                 version: null,
-                                 app_min_version: null,
-                                 app_max_version: null,
-                                 description: null,
-                                 platforms: null,
-                                 environments: null,
-                                 locale_codes: null,
-                                 tags: null,
-                                 project: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::ReleasePreview.new(id: nil,
+                                 version: nil,
+                                 app_min_version: nil,
+                                 app_max_version: nil,
+                                 description: nil,
+                                 platforms: nil,
+                                 environments: nil,
+                                 locale_codes: nil,
+                                 tags: nil,
+                                 project: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/ReleaseTrigger.md

@@ -19,19 +19,19 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ReleaseTrigger.new(id: null,
-                                 branch: null,
-                                 cron_schedule: null,
-                                 time_zone: null,
-                                 next_run_at: null,
-                                 app_min_version: null,
-                                 app_max_version: null,
-                                 locales: null,
-                                 tags: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::ReleaseTrigger.new(id: nil,
+                                 branch: nil,
+                                 cron_schedule: nil,
+                                 time_zone: nil,
+                                 next_run_at: nil,
+                                 app_min_version: nil,
+                                 app_max_version: nil,
+                                 locales: nil,
+                                 tags: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/ReleaseUpdateParameters.md

@@ -13,13 +13,13 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ReleaseUpdateParameters.new(description: My first Release,
-                                 platforms: ["android","ios"],
-                                 app_min_version: 2.5.0,
-                                 app_max_version: 3.0.0,
-                                 branch: my-feature-branch)
+instance = Phrase::ReleaseUpdateParameters.new(description: 'My first Release',
+                                 platforms: ["android","ios"],
+                                 app_min_version: '2.5.0',
+                                 app_max_version: '3.0.0',
+                                 branch: 'my-feature-branch')
 ```
 
 

data/docs/ReleaseUpdateParameters1.md

@@ -15,15 +15,15 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ReleaseUpdateParameters1.new(cron_schedule: 15 18 * * 1,3,
-                                 time_zone: Europe/Berlin,
-                                 locale_ids: ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],
-                                 tags: ["android","feature1"],
-                                 branch: my-feature-branch,
-                                 app_min_version: 1.0.0,
-                                 app_max_version: 2.0.0)
+instance = Phrase::ReleaseUpdateParameters1.new(cron_schedule: '15 18 * * 1,3',
+                                 time_zone: 'Europe/Berlin',
+                                 locale_ids: ["abcd1234cdef1234abcd1234cdef1234","fff565db236400772368235db2c6117e"],
+                                 tags: ["android","feature1"],
+                                 branch: 'my-feature-branch',
+                                 app_min_version: '1.0.0',
+                                 app_max_version: '2.0.0')
 ```
 
 

data/docs/RepoSync.md

@@ -19,19 +19,19 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::RepoSync.new(id: null,
-                                 name: null,
-                                 project: null,
-                                 provider: null,
-                                 enabled: null,
-                                 auto_import: null,
-                                 repo_name: null,
-                                 pr_branch: null,
-                                 created_at: null,
-                                 last_import_at: null,
-                                 last_export_at: null)
+instance = Phrase::RepoSync.new(id: nil,
+                                 name: nil,
+                                 project: nil,
+                                 provider: nil,
+                                 enabled: nil,
+                                 auto_import: nil,
+                                 repo_name: nil,
+                                 pr_branch: nil,
+                                 created_at: nil,
+                                 last_import_at: nil,
+                                 last_export_at: nil)
 ```
 
 

data/docs/RepoSyncCreateParameters.md

@@ -18,18 +18,18 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::RepoSyncCreateParameters.new(project_id: abcd1234abcd1234abcd1234abcd1234,
-                                 name: null,
-                                 git_provider: github,
-                                 connection_type: github_app,
-                                 repo_name: my-org/my-repo,
-                                 base_branch: main,
-                                 pr_branch: phrase-translations,
+instance = Phrase::RepoSyncCreateParameters.new(project_id: 'abcd1234abcd1234abcd1234abcd1234',
+                                 name: nil,
+                                 git_provider: 'github',
+                                 connection_type: 'github_app',
+                                 repo_name: 'my-org/my-repo',
+                                 base_branch: 'main',
+                                 pr_branch: 'phrase-translations',
                                  auto_import: false,
-                                 access_token: ghp_xxxxxxxxxxxxxxxxxxxx,
-                                 custom_api_endpoint: https://git.example.com/api/v4)
+                                 access_token: 'ghp_xxxxxxxxxxxxxxxxxxxx',
+                                 custom_api_endpoint: 'https://git.example.com/api/v4')
 ```
 
 

data/docs/RepoSyncEvent.md

@@ -15,15 +15,15 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::RepoSyncEvent.new(id: null,
-                                 type: null,
-                                 created_at: null,
-                                 status: null,
-                                 pull_request_url: null,
-                                 auto_import: null,
-                                 errors: null)
+instance = Phrase::RepoSyncEvent.new(id: nil,
+                                 type: nil,
+                                 created_at: nil,
+                                 status: nil,
+                                 pull_request_url: nil,
+                                 auto_import: nil,
+                                 errors: nil)
 ```
 
 

data/docs/RepoSyncExportParameters.md

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

data/docs/RepoSyncImportParameters.md

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

data/docs/RepoSyncsApi.md

@@ -360,7 +360,9 @@ end
 api_instance = Phrase::RepoSyncsApi.new
 account_id = 'account_id_example' # String | Account ID
 opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  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
@@ -379,6 +381,8 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **account_id** | **String**| Account ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [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
 

data/docs/ReportsApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *https://api.phrase.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**report_locales_list**](ReportsApi.md#report_locales_list) | **GET** /projects/{project_id}/report/locales | List Locale Reports
+[**report_locales_list**](ReportsApi.md#report_locales_list) | **GET** /projects/{project_id}/report/locales | List Locale Reports (word count, character count, translation statistics)
 [**report_show**](ReportsApi.md#report_show) | **GET** /projects/{project_id}/report | Get Project Report
 
 
@@ -13,9 +13,9 @@ Method | HTTP request | Description
 
 > Array<LocaleReport> report_locales_list(project_id, opts)
 
-List Locale Reports
+List Locale Reports (word count, character count, translation statistics)
 
-List all locale reports for the given project
+List all locale reports for the given project. Each report includes translation statistics per locale, including word count and character count fields (`source_word_count`, `word_count`, `word_count_unverified`, `word_count_missing`) as well as translation completion statistics (`keys_count`, `completed_translations_count`, `untranslated_keys_count`, `unverified_translations_count`, `reviewed_translations_count`, and their percentages). Use the `tag` parameter to scope the report to a specific job (e.g. its job tag) to get job-scoped word count statistics.
 
 ### Example
 
@@ -45,7 +45,7 @@ opts = {
 }
 
 begin
-  #List Locale Reports
+  #List Locale Reports (word count, character count, translation statistics)
   result = api_instance.report_locales_list(project_id, opts)
   pp result
 rescue Phrase::ApiError => e

data/docs/Screenshot.md

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

data/docs/ScreenshotMarker.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ScreenshotMarker.new(id: null,
-                                 presentation: null,
-                                 presentation_type: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 translation_key: null)
+instance = Phrase::ScreenshotMarker.new(id: nil,
+                                 presentation: nil,
+                                 presentation_type: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 translation_key: nil)
 ```
 
 

data/docs/ScreenshotMarkerCreateParameters.md

@@ -11,11 +11,11 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ScreenshotMarkerCreateParameters.new(branch: my-feature-branch,
-                                 key_id: abcd1234abcd1234abcd1234abcd1234,
-                                 presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
+instance = Phrase::ScreenshotMarkerCreateParameters.new(branch: 'my-feature-branch',
+                                 key_id: 'abcd1234abcd1234abcd1234abcd1234',
+                                 presentation: '{ "x": 100, "y": 100, "w": 100, "h": 100 }')
 ```
 
 

data/docs/ScreenshotMarkerPresentation.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ScreenshotMarkerPresentation.new(x: null,
-                                 y: null,
-                                 w: null,
-                                 h: null)
+instance = Phrase::ScreenshotMarkerPresentation.new(x: nil,
+                                 y: nil,
+                                 w: nil,
+                                 h: nil)
 ```
 
 

data/docs/ScreenshotMarkerUpdateParameters.md

@@ -11,11 +11,11 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ScreenshotMarkerUpdateParameters.new(branch: my-feature-branch,
-                                 key_id: abcd1234abcd1234abcd1234abcd1234,
-                                 presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
+instance = Phrase::ScreenshotMarkerUpdateParameters.new(branch: 'my-feature-branch',
+                                 key_id: 'abcd1234abcd1234abcd1234abcd1234',
+                                 presentation: '{ "x": 100, "y": 100, "w": 100, "h": 100 }')
 ```
 
 

data/docs/ScreenshotUpdateParameters.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::ScreenshotUpdateParameters.new(branch: my-feature-branch,
-                                 name: A screenshot name,
-                                 description: A screenshot description,
-                                 filename: [B@6eec5a54)
+instance = Phrase::ScreenshotUpdateParameters.new(branch: 'my-feature-branch',
+                                 name: 'A screenshot name',
+                                 description: 'A screenshot description',
+                                 filename: File.new('/path/to/file'))
 ```
 
 

data/docs/SearchInAccountParameters.md

@@ -13,13 +13,13 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::SearchInAccountParameters.new(query: keyword,
-                                 locale_code: de_DE,
+instance = Phrase::SearchInAccountParameters.new(query: 'keyword',
+                                 locale_code: 'de_DE',
                                  page: 1,
                                  per_page: 25,
-                                 project_ids: ["abcd1234abcd1234abcd1234abcd1234"])
+                                 project_ids: ["abcd1234abcd1234abcd1234abcd1234"])
 ```
 
 

data/docs/Space.md

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

data/docs/Space1.md

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

data/docs/SpaceCreateParameters.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::SpaceCreateParameters.new(name: My Android Projects)
+instance = Phrase::SpaceCreateParameters.new(name: 'My Android Projects')
 ```
 
 

data/docs/SpaceUpdateParameters.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::SpaceUpdateParameters.new(name: My Android Projects)
+instance = Phrase::SpaceUpdateParameters.new(name: 'My Android Projects')
 ```
 
 

data/docs/SpacesProjectsCreateParameters.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::SpacesProjectsCreateParameters.new(id: a4b3c2d1)
+instance = Phrase::SpacesProjectsCreateParameters.new(id: 'a4b3c2d1')
 ```
 
 

data/docs/Styleguide.md

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

data/docs/StyleguideCreateParameters.md

@@ -21,21 +21,21 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::StyleguideCreateParameters.new(title: Web application style guide,
-                                 audience: customer-facing,
-                                 target_audience: teenager,
-                                 grammatical_person: first_person_singular,
-                                 vocabulary_type: technical,
-                                 business: We are a travel site that helps customers find the best hotels and flights.,
-                                 company_branding: ACME Inc. should never be translated.,
-                                 formatting: Never use capital letters,
-                                 glossary_terms: Apartment, cabin, loft,
-                                 grammar_consistency: ,
-                                 literal_translation: Neutral,
-                                 overall_tone: Tone should be fun and light,
-                                 samples: http://www.myexample.com/my/document/path/to/samples.pdf)
+instance = Phrase::StyleguideCreateParameters.new(title: 'Web application style guide',
+                                 audience: 'customer-facing',
+                                 target_audience: 'teenager',
+                                 grammatical_person: 'first_person_singular',
+                                 vocabulary_type: 'technical',
+                                 business: 'We are a travel site that helps customers find the best hotels and flights.',
+                                 company_branding: 'ACME Inc. should never be translated.',
+                                 formatting: 'Never use capital letters',
+                                 glossary_terms: 'Apartment, cabin, loft',
+                                 grammar_consistency: '',
+                                 literal_translation: 'Neutral',
+                                 overall_tone: 'Tone should be fun and light',
+                                 samples: 'http://www.myexample.com/my/document/path/to/samples.pdf')
 ```
 
 

data/docs/StyleguideDetails.md

@@ -25,25 +25,25 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::StyleguideDetails.new(id: null,
-                                 title: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 public_url: null,
-                                 audience: null,
-                                 target_audience: null,
-                                 grammatical_person: null,
-                                 vocabulary_type: null,
-                                 business: null,
-                                 company_branding: null,
-                                 formatting: null,
-                                 glossary_terms: null,
-                                 grammar_consistency: null,
-                                 literal_translation: null,
-                                 overall_tone: null,
-                                 samples: null)
+instance = Phrase::StyleguideDetails.new(id: nil,
+                                 title: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 public_url: nil,
+                                 audience: nil,
+                                 target_audience: nil,
+                                 grammatical_person: nil,
+                                 vocabulary_type: nil,
+                                 business: nil,
+                                 company_branding: nil,
+                                 formatting: nil,
+                                 glossary_terms: nil,
+                                 grammar_consistency: nil,
+                                 literal_translation: nil,
+                                 overall_tone: nil,
+                                 samples: nil)
 ```
 
 

data/docs/StyleguidePreview.md

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