phrase 4.22.0 → 4.24.0

data/lib/phrase/models/styleguide_update_parameters.rb

@@ -8,13 +8,13 @@ module Phrase
     # Audience description
     attr_accessor :audience
 
-    # Can be one of: not_specified, children, teenager, young_adults, adults, old_adults.
+    # Target audience for the translations.
     attr_accessor :target_audience
 
-    # Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural.
+    # Preferred grammatical person.
     attr_accessor :grammatical_person
 
-    # Can be one of: not_specified, popular, technical, fictional.
+    # Vocabulary register the translations should use.
     attr_accessor :vocabulary_type
 
     # Description of the business
@@ -41,6 +41,28 @@ module Phrase
     # Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency.
     attr_accessor :samples
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -163,9 +185,45 @@ module Phrase
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      target_audience_validator = EnumAttributeValidator.new('String', ["not_specified", "children", "teenager", "young_adults", "adults", "old_adults"])
+      return false unless target_audience_validator.valid?(@target_audience)
+      grammatical_person_validator = EnumAttributeValidator.new('String', ["not_specified", "first_person_singular", "second_person_singular", "third_person_singular_masculine", "third_person_singular_feminine", "third_person_singular_neuter", "first_person_plural", "second_person_plural", "third_person_plural"])
+      return false unless grammatical_person_validator.valid?(@grammatical_person)
+      vocabulary_type_validator = EnumAttributeValidator.new('String', ["not_specified", "popular", "technical", "fictional"])
+      return false unless vocabulary_type_validator.valid?(@vocabulary_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] target_audience Object to be assigned
+    def target_audience=(target_audience)
+      validator = EnumAttributeValidator.new('String', ["not_specified", "children", "teenager", "young_adults", "adults", "old_adults"])
+      unless validator.valid?(target_audience)
+        fail ArgumentError, "invalid value for \"target_audience\", must be one of #{validator.allowable_values}."
+      end
+      @target_audience = target_audience
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] grammatical_person Object to be assigned
+    def grammatical_person=(grammatical_person)
+      validator = EnumAttributeValidator.new('String', ["not_specified", "first_person_singular", "second_person_singular", "third_person_singular_masculine", "third_person_singular_feminine", "third_person_singular_neuter", "first_person_plural", "second_person_plural", "third_person_plural"])
+      unless validator.valid?(grammatical_person)
+        fail ArgumentError, "invalid value for \"grammatical_person\", must be one of #{validator.allowable_values}."
+      end
+      @grammatical_person = grammatical_person
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] vocabulary_type Object to be assigned
+    def vocabulary_type=(vocabulary_type)
+      validator = EnumAttributeValidator.new('String', ["not_specified", "popular", "technical", "fictional"])
+      unless validator.valid?(vocabulary_type)
+        fail ArgumentError, "invalid value for \"vocabulary_type\", must be one of #{validator.allowable_values}."
+      end
+      @vocabulary_type = vocabulary_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/phrase/models/tag.rb

@@ -6,6 +6,9 @@ module Phrase
 
     attr_accessor :keys_count
 
+    # `true` when the tag was created automatically by the system (e.g. for jobs, uploads, or Figma attachments) rather than by a user. 
+    attr_accessor :system_tag
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -15,6 +18,7 @@ module Phrase
       {
         :'name' => :'name',
         :'keys_count' => :'keys_count',
+        :'system_tag' => :'system_tag',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
       }
@@ -25,6 +29,7 @@ module Phrase
       {
         :'name' => :'String',
         :'keys_count' => :'Integer',
+        :'system_tag' => :'Boolean',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime'
       }
@@ -59,6 +64,10 @@ module Phrase
         self.keys_count = attributes[:'keys_count']
       end
 
+      if attributes.key?(:'system_tag')
+        self.system_tag = attributes[:'system_tag']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -88,6 +97,7 @@ module Phrase
       self.class == o.class &&
           name == o.name &&
           keys_count == o.keys_count &&
+          system_tag == o.system_tag &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -101,7 +111,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, keys_count, created_at, updated_at].hash
+      [name, keys_count, system_tag, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/tag_with_stats.rb

@@ -6,6 +6,9 @@ module Phrase
 
     attr_accessor :keys_count
 
+    # `true` when the tag was created automatically by the system (e.g. for jobs, uploads, or Figma attachments) rather than by a user. 
+    attr_accessor :system_tag
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -17,6 +20,7 @@ module Phrase
       {
         :'name' => :'name',
         :'keys_count' => :'keys_count',
+        :'system_tag' => :'system_tag',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
         :'statistics' => :'statistics'
@@ -28,6 +32,7 @@ module Phrase
       {
         :'name' => :'String',
         :'keys_count' => :'Integer',
+        :'system_tag' => :'Boolean',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
         :'statistics' => :'Array<TagWithStats1Statistics1>'
@@ -70,6 +75,10 @@ module Phrase
         self.keys_count = attributes[:'keys_count']
       end
 
+      if attributes.key?(:'system_tag')
+        self.system_tag = attributes[:'system_tag']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -105,6 +114,7 @@ module Phrase
       self.class == o.class &&
           name == o.name &&
           keys_count == o.keys_count &&
+          system_tag == o.system_tag &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           statistics == o.statistics
@@ -119,7 +129,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, keys_count, created_at, updated_at, statistics].hash
+      [name, keys_count, system_tag, created_at, updated_at, statistics].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/translation_create_parameters.rb

@@ -26,6 +26,12 @@ module Phrase
     # Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled.
     attr_accessor :autotranslate
 
+    # When `true`, the translation is marked as a minor edit and does not trigger downstream re-verification on the linked locales' translations. 
+    attr_accessor :minor_change
+
+    # When `true` and the project's review workflow is enabled, the translation is created in the `reviewed` state. 
+    attr_accessor :reviewed
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -36,7 +42,9 @@ module Phrase
         :'plural_suffix' => :'plural_suffix',
         :'unverified' => :'unverified',
         :'excluded' => :'excluded',
-        :'autotranslate' => :'autotranslate'
+        :'autotranslate' => :'autotranslate',
+        :'minor_change' => :'minor_change',
+        :'reviewed' => :'reviewed'
       }
     end
 
@@ -50,7 +58,9 @@ module Phrase
         :'plural_suffix' => :'String',
         :'unverified' => :'Boolean',
         :'excluded' => :'Boolean',
-        :'autotranslate' => :'Boolean'
+        :'autotranslate' => :'Boolean',
+        :'minor_change' => :'Boolean',
+        :'reviewed' => :'Boolean'
       }
     end
 
@@ -106,6 +116,14 @@ module Phrase
       if attributes.key?(:'autotranslate')
         self.autotranslate = attributes[:'autotranslate']
       end
+
+      if attributes.key?(:'minor_change')
+        self.minor_change = attributes[:'minor_change']
+      end
+
+      if attributes.key?(:'reviewed')
+        self.reviewed = attributes[:'reviewed']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -133,7 +151,9 @@ module Phrase
           plural_suffix == o.plural_suffix &&
           unverified == o.unverified &&
           excluded == o.excluded &&
-          autotranslate == o.autotranslate
+          autotranslate == o.autotranslate &&
+          minor_change == o.minor_change &&
+          reviewed == o.reviewed
     end
 
     # @see the `==` method
@@ -145,7 +165,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, locale_id, key_id, content, plural_suffix, unverified, excluded, autotranslate].hash
+      [branch, locale_id, key_id, content, plural_suffix, unverified, excluded, autotranslate, minor_change, reviewed].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/translation_order.rb

@@ -24,7 +24,8 @@ module Phrase
 
     attr_accessor :target_locales
 
-    attr_accessor :tag
+    # Name of the tag whose keys are included in the order.
+    attr_accessor :tag_name
 
     attr_accessor :styleguide
 
@@ -52,7 +53,7 @@ module Phrase
         :'progress_percent' => :'progress_percent',
         :'source_locale' => :'source_locale',
         :'target_locales' => :'target_locales',
-        :'tag' => :'tag',
+        :'tag_name' => :'tag_name',
         :'styleguide' => :'styleguide',
         :'unverify_translations_upon_delivery' => :'unverify_translations_upon_delivery',
         :'quality' => :'quality',
@@ -76,7 +77,7 @@ module Phrase
         :'progress_percent' => :'Integer',
         :'source_locale' => :'LocalePreview',
         :'target_locales' => :'Array<LocalePreview>',
-        :'tag' => :'String',
+        :'tag_name' => :'String',
         :'styleguide' => :'StyleguidePreview',
         :'unverify_translations_upon_delivery' => :'Boolean',
         :'quality' => :'Boolean',
@@ -153,8 +154,8 @@ module Phrase
         end
       end
 
-      if attributes.key?(:'tag')
-        self.tag = attributes[:'tag']
+      if attributes.key?(:'tag_name')
+        self.tag_name = attributes[:'tag_name']
       end
 
       if attributes.key?(:'styleguide')
@@ -211,7 +212,7 @@ module Phrase
           progress_percent == o.progress_percent &&
           source_locale == o.source_locale &&
           target_locales == o.target_locales &&
-          tag == o.tag &&
+          tag_name == o.tag_name &&
           styleguide == o.styleguide &&
           unverify_translations_upon_delivery == o.unverify_translations_upon_delivery &&
           quality == o.quality &&
@@ -229,7 +230,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, lsp, amount_in_cents, currency, message, state, translation_type, progress_percent, source_locale, target_locales, tag, styleguide, unverify_translations_upon_delivery, quality, priority, created_at, updated_at].hash
+      [id, name, lsp, amount_in_cents, currency, message, state, translation_type, progress_percent, source_locale, target_locales, tag_name, styleguide, unverify_translations_upon_delivery, quality, priority, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/translation_update_parameters.rb

@@ -23,6 +23,9 @@ module Phrase
     # When set to `true`, the translation will be marked as reviewed.
     attr_accessor :reviewed
 
+    # When `true`, the update is treated as a minor edit and does not trigger downstream re-verification on the linked locales' translations. 
+    attr_accessor :minor_change
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -32,7 +35,8 @@ module Phrase
         :'unverified' => :'unverified',
         :'excluded' => :'excluded',
         :'autotranslate' => :'autotranslate',
-        :'reviewed' => :'reviewed'
+        :'reviewed' => :'reviewed',
+        :'minor_change' => :'minor_change'
       }
     end
 
@@ -45,7 +49,8 @@ module Phrase
         :'unverified' => :'Boolean',
         :'excluded' => :'Boolean',
         :'autotranslate' => :'Boolean',
-        :'reviewed' => :'Boolean'
+        :'reviewed' => :'Boolean',
+        :'minor_change' => :'Boolean'
       }
     end
 
@@ -97,6 +102,10 @@ module Phrase
       if attributes.key?(:'reviewed')
         self.reviewed = attributes[:'reviewed']
       end
+
+      if attributes.key?(:'minor_change')
+        self.minor_change = attributes[:'minor_change']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -123,7 +132,8 @@ module Phrase
           unverified == o.unverified &&
           excluded == o.excluded &&
           autotranslate == o.autotranslate &&
-          reviewed == o.reviewed
+          reviewed == o.reviewed &&
+          minor_change == o.minor_change
     end
 
     # @see the `==` method
@@ -135,7 +145,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, content, plural_suffix, unverified, excluded, autotranslate, reviewed].hash
+      [branch, content, plural_suffix, unverified, excluded, autotranslate, reviewed, minor_change].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/upload_batch.rb

@@ -3,11 +3,14 @@ require 'date'
 module Phrase
   class UploadBatch
     # Processing state of the upload batch
-    attr_accessor :state
+    attr_accessor :status
 
     # Indicates whether unmentioned keys will be deleted after processing all uploads in the batch
     attr_accessor :delete_unmentioned_keys
 
+    # Number of uploads attached to this batch.
+    attr_accessor :uploads_count
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -43,8 +46,9 @@ module Phrase
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'state' => :'state',
+        :'status' => :'status',
         :'delete_unmentioned_keys' => :'delete_unmentioned_keys',
+        :'uploads_count' => :'uploads_count',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
         :'project' => :'project',
@@ -56,8 +60,9 @@ module Phrase
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'state' => :'String',
+        :'status' => :'String',
         :'delete_unmentioned_keys' => :'Boolean',
+        :'uploads_count' => :'Integer',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
         :'project' => :'ProjectShort',
@@ -87,14 +92,18 @@ module Phrase
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
       end
 
       if attributes.key?(:'delete_unmentioned_keys')
         self.delete_unmentioned_keys = attributes[:'delete_unmentioned_keys']
       end
 
+      if attributes.key?(:'uploads_count')
+        self.uploads_count = attributes[:'uploads_count']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -128,19 +137,19 @@ module Phrase
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      state_validator = EnumAttributeValidator.new('String', ["started", "done"])
-      return false unless state_validator.valid?(@state)
+      status_validator = EnumAttributeValidator.new('String', ["started", "done"])
+      return false unless status_validator.valid?(@status)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] state Object to be assigned
-    def state=(state)
+    # @param [Object] status Object to be assigned
+    def status=(status)
       validator = EnumAttributeValidator.new('String', ["started", "done"])
-      unless validator.valid?(state)
-        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
-      @state = state
+      @status = status
     end
 
     # Checks equality by comparing each attribute.
@@ -148,8 +157,9 @@ module Phrase
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          state == o.state &&
+          status == o.status &&
           delete_unmentioned_keys == o.delete_unmentioned_keys &&
+          uploads_count == o.uploads_count &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           project == o.project &&
@@ -166,7 +176,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [state, delete_unmentioned_keys, created_at, updated_at, project, user, uploads].hash
+      [status, delete_unmentioned_keys, uploads_count, created_at, updated_at, project, user, uploads].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/upload_summary.rb

@@ -8,7 +8,7 @@ module Phrase
 
     attr_accessor :translation_keys_updated
 
-    # The number of translation keys in the project that were not mentioned in the upload.  Note: this field is not calculated (and shows 0) if the upload contains more than 10,000 keys. 
+    # The number of translation keys in the project that were not mentioned in the upload.  Note: this field is not calculated (and shows 0) if the upload contains more than 100,000 keys. 
     attr_accessor :translation_keys_unmentioned
 
     attr_accessor :translations_created

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '4.22.0'
+  VERSION = '4.24.0'
 end

data/lib/phrase.rb

@@ -41,13 +41,13 @@ require 'phrase/models/custom_metadata_data_type'
 require 'phrase/models/custom_metadata_properties_create_parameters'
 require 'phrase/models/custom_metadata_properties_update_parameters'
 require 'phrase/models/custom_metadata_property'
-require 'phrase/models/custom_metadata_property_create422_response'
-require 'phrase/models/custom_metadata_property_create422_response_errors_inner'
 require 'phrase/models/distribution'
 require 'phrase/models/distribution_create_parameters'
-require 'phrase/models/distribution_preview'
+require 'phrase/models/distribution_details'
 require 'phrase/models/distribution_update_parameters'
 require 'phrase/models/document'
+require 'phrase/models/document_delete422_response'
+require 'phrase/models/document_delete422_response_errors_inner'
 require 'phrase/models/error'
 require 'phrase/models/error_error'
 require 'phrase/models/figma_attachment'
@@ -58,6 +58,7 @@ require 'phrase/models/glossary'
 require 'phrase/models/glossary_create_parameters'
 require 'phrase/models/glossary_term'
 require 'phrase/models/glossary_term_create_parameters'
+require 'phrase/models/glossary_term_glossary'
 require 'phrase/models/glossary_term_translation'
 require 'phrase/models/glossary_term_translation_create_parameters'
 require 'phrase/models/glossary_term_translation_update_parameters'
@@ -170,6 +171,7 @@ require 'phrase/models/repo_sync_import_parameters'
 require 'phrase/models/screenshot'
 require 'phrase/models/screenshot_marker'
 require 'phrase/models/screenshot_marker_create_parameters'
+require 'phrase/models/screenshot_marker_presentation'
 require 'phrase/models/screenshot_marker_update_parameters'
 require 'phrase/models/screenshot_update_parameters'
 require 'phrase/models/search_in_account_parameters'

data/spec/api/branches_api_spec.rb

@@ -51,7 +51,7 @@ describe 'BranchesApi' do
 
   # unit tests for branch_create
   # Create a branch
-  # Create a new branch.  *Note: Creating a new branch may take several minutes depending on the project size.* 
+  # Create a new branch.  Branch project provisioning runs asynchronously, so the newly created branch is returned in a transitional state (typically `creating_branch`) and only reaches `success` once the underlying project has been set up. Poll the branch resource until its `state` becomes `success` before performing further operations on it.  Requires the Branching feature to be enabled on the account.  *Note: Creating a new branch may take several minutes depending on the project size.* 
   # @param project_id Project ID
   # @param branch_create_parameters 
   # @param [Hash] opts the optional parameters
@@ -65,7 +65,7 @@ describe 'BranchesApi' do
 
   # unit tests for branch_delete
   # Delete a branch
-  # Delete an existing branch.
+  # Delete an existing branch.  A branch cannot be deleted while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with `409 Conflict`. A branch whose current `state` does not allow deletion (for example, while a merge or sync is in progress) is rejected with `422 Unprocessable Entity`.  Requires the Branching feature to be enabled on the account. 
   # @param project_id Project ID
   # @param name name
   # @param [Hash] opts the optional parameters
@@ -79,7 +79,7 @@ describe 'BranchesApi' do
 
   # unit tests for branch_merge
   # Merge a branch
-  # Merge an existing branch.  *Note: Merging a branch may take several minutes depending on diff size.* 
+  # Merge an existing branch back into its base branch.  The merge runs asynchronously. The branch transitions to `merging_branch` and settles in `merged`, `merge_error`, or `merge_conflict` once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state.  A branch cannot be merged while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with `409 Conflict`. A branch whose current `state` does not allow a merge is rejected with `422 Unprocessable Entity`.  Requires the Branching feature to be enabled on the account.  *Note: Merging a branch may take several minutes depending on diff size.* 
   # @param project_id Project ID
   # @param name name
   # @param branch_merge_parameters 
@@ -94,7 +94,7 @@ describe 'BranchesApi' do
 
   # unit tests for branch_show
   # Get a single branch
-  # Get details on a single branch for a given project.
+  # Get details on a single branch for a given project.  Requires the Branching feature to be enabled on the account. 
   # @param project_id Project ID
   # @param name name
   # @param [Hash] opts the optional parameters
@@ -108,7 +108,7 @@ describe 'BranchesApi' do
 
   # unit tests for branch_sync
   # Sync a branch
-  # Sync an existing branch.  *Note: Only available for branches created with new branching.* 
+  # Pull changes from the base branch into this branch, applying the chosen conflict-resolution strategy.  The sync runs asynchronously. The branch transitions to `syncing_branch` and settles back into `success` (or `merge_conflict` / `branch_error`) once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state.  Only branches created with the newer branching system can be synced. Requests against branches from the older system, or against branches whose current state does not allow a sync, are rejected with `422 Unprocessable Entity` and an empty body.  Requires the Branching feature to be enabled on the account. 
   # @param project_id Project ID
   # @param name name
   # @param branch_sync_parameters 
@@ -123,7 +123,7 @@ describe 'BranchesApi' do
 
   # unit tests for branch_update
   # Update a branch
-  # Update an existing branch.
+  # Update an existing branch. Only the branch name can be changed.  Requires the Branching feature to be enabled on the account. 
   # @param project_id Project ID
   # @param name name
   # @param branch_update_parameters 
@@ -138,7 +138,7 @@ describe 'BranchesApi' do
 
   # unit tests for branches_list
   # List branches
-  # List all branches the of the current project.
+  # List all branches of the current project.  Requires the Branching feature to be enabled on the account. 
   # @param project_id Project ID
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)

data/spec/api/comments_api_spec.rb

@@ -143,8 +143,8 @@ describe 'CommentsApi' do
   # @option opts [String] :branch specify the branch to use
   # @option opts [String] :query Search query for comment messages
   # @option opts [Array<String>] :locale_ids Search comments by their assigned locales
-  # @option opts [Array<String>] :filters Specify the filter for the comments
-  # @option opts [String] :order Order direction. Can be one of: asc, desc.
+  # @option opts [Array<String>] :filters Specify the filter for the comments. Supported values are &#x60;read&#x60; and &#x60;unread&#x60;. Combine both to return all comments (read + unread) without filtering.
+  # @option opts [String] :order Order direction. Defaults to &#x60;desc&#x60;. Values other than &#x60;asc&#x60; and &#x60;desc&#x60; fall back to &#x60;desc&#x60;.
   # @return [Array<Comment>]
   describe 'comments_list test' do
     it 'should work' do

data/spec/api/distributions_api_spec.rb

@@ -27,7 +27,7 @@ describe 'DistributionsApi' do
   # @param distribution_create_parameters 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-  # @return [Distribution]
+  # @return [DistributionDetails]
   describe 'distribution_create test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -55,7 +55,7 @@ describe 'DistributionsApi' do
   # @param id ID
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-  # @return [Distribution]
+  # @return [DistributionDetails]
   describe 'distribution_show test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -70,7 +70,7 @@ describe 'DistributionsApi' do
   # @param distribution_update_parameters 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
-  # @return [Distribution]
+  # @return [DistributionDetails]
   describe 'distribution_update test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -85,7 +85,7 @@ describe 'DistributionsApi' do
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @option opts [Integer] :page Page number
   # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
-  # @return [Array<DistributionPreview>]
+  # @return [Array<Distribution>]
   describe 'distributions_list test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/documents_api_spec.rb

@@ -42,6 +42,7 @@ describe 'DocumentsApi' do
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @option opts [Integer] :page Page number
   # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  # @option opts [String] :q Search query. Filters documents by name (case-insensitive substring match).
   # @return [Array<Document>]
   describe 'documents_list test' do
     it 'should work' do