phrase 4.28.0 → 4.30.0

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)
 ```
 
 

data/docs/StyleguideUpdateParameters.md

@@ -21,21 +21,21 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::StyleguideUpdateParameters.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::StyleguideUpdateParameters.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/Subscription.md

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

data/docs/SupportedLanguagesApi.md

@@ -0,0 +1,62 @@
+# Phrase::SupportedLanguagesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**languages_list**](SupportedLanguagesApi.md#languages_list) | **GET** /languages | List supported languages
+
+
+
+## languages_list
+
+> Hash<String, String> languages_list
+
+List supported languages
+
+Returns all languages/locale codes that Phrase Strings recognizes, mapped to their human-readable display name. This endpoint does not require authentication. 
+
+### 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::SupportedLanguagesApi.new
+
+begin
+  #List supported languages
+  result = api_instance.languages_list
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling SupportedLanguagesApi->languages_list: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+Response<(**Hash&lt;String, String&gt;**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Tag.md

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

data/docs/TagCreateParameters.md

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

data/docs/TagWithStats.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::TagWithStats.new(name: null,
-                                 keys_count: null,
-                                 system_tag: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 statistics: null)
+instance = Phrase::TagWithStats.new(name: nil,
+                                 keys_count: nil,
+                                 system_tag: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 statistics: nil)
 ```
 
 

data/docs/TagWithStats1Statistics.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::TagWithStats1Statistics.new(keys_total_count: null,
-                                 translations_completed_count: null,
-                                 translations_unverified_count: null,
-                                 keys_untranslated_count: null)
+instance = Phrase::TagWithStats1Statistics.new(keys_total_count: nil,
+                                 translations_completed_count: nil,
+                                 translations_unverified_count: nil,
+                                 keys_untranslated_count: nil)
 ```
 
 

data/docs/TagWithStats1Statistics1.md

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

data/docs/Team.md

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

data/docs/TeamCreateParameters.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::TeamCreateParameters.new(name: German Translators)
+instance = Phrase::TeamCreateParameters.new(name: 'German Translators')
 ```
 
 

data/docs/TeamDetail.md

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

data/docs/TeamShort.md

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

data/docs/TeamUpdateParameters.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::TeamUpdateParameters.new(name: German Translators)
+instance = Phrase::TeamUpdateParameters.new(name: 'German Translators')
 ```
 
 

data/docs/TeamsProjectsCreateParameters.md

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

data/docs/TeamsSpacesCreateParameters.md

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

data/docs/TeamsUsersCreateParameters.md

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

data/docs/Translation.md

@@ -20,20 +20,20 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::Translation.new(id: null,
-                                 content: null,
-                                 unverified: null,
-                                 excluded: null,
-                                 plural_suffix: null,
-                                 key: null,
-                                 locale: null,
-                                 placeholders: null,
-                                 state: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 linked_translation: null)
+instance = Phrase::Translation.new(id: nil,
+                                 content: nil,
+                                 unverified: nil,
+                                 excluded: nil,
+                                 plural_suffix: nil,
+                                 key: nil,
+                                 locale: nil,
+                                 placeholders: nil,
+                                 state: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 linked_translation: nil)
 ```
 
 

data/docs/TranslationCreateParameters.md

@@ -18,16 +18,16 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::TranslationCreateParameters.new(branch: my-feature-branch,
-                                 locale_id: abcd1234cdef1234abcd1234cdef1234,
-                                 key_id: abcd1234cdef1234abcd1234cdef1234,
-                                 content: My translation,
-                                 plural_suffix: null,
-                                 unverified: null,
-                                 excluded: null,
-                                 autotranslate: null,
+instance = Phrase::TranslationCreateParameters.new(branch: 'my-feature-branch',
+                                 locale_id: 'abcd1234cdef1234abcd1234cdef1234',
+                                 key_id: 'abcd1234cdef1234abcd1234cdef1234',
+                                 content: 'My translation',
+                                 plural_suffix: nil,
+                                 unverified: nil,
+                                 excluded: nil,
+                                 autotranslate: nil,
                                  minor_change: false,
                                  reviewed: false)
 ```