phrase 4.22.0 → 4.24.0

data/lib/phrase/models/project_update_parameters.rb

@@ -2,7 +2,7 @@ require 'date'
 
 module Phrase
   class ProjectUpdateParameters
-    # Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in.
+    # (Optional) ID of an account the requesting user belongs to. Used only to disambiguate the request context; the project itself cannot be moved between accounts through this endpoint. 
     attr_accessor :account_id
 
     # (Optional) Name of the project
@@ -77,6 +77,27 @@ module Phrase
     # (Optional) List of placeholder styles enabled for the project.
     attr_accessor :placeholder_styles
 
+    # (Optional) Enable autocomplete-job behavior so that newly created keys and locales are automatically added to in-progress jobs.
+    attr_accessor :autocomplete_job_enabled
+
+    # (Optional) When enabled, translations are locked once a job moves into review.
+    attr_accessor :job_locking_enabled
+
+    # (Optional) Enable Smart Suggest for the project.
+    attr_accessor :smart_suggest_enabled
+
+    # (Optional) Allow Smart Suggest to source suggestions from the project glossary.
+    attr_accessor :smart_suggest_use_glossary
+
+    # (Optional) Allow Smart Suggest to source suggestions from machine translation.
+    attr_accessor :smart_suggest_use_machine_translation
+
+    # (Optional) Collation used when sorting translation keys alphabetically.
+    attr_accessor :translation_keys_sort_collation
+
+    # (Optional) CLDR plural-rule version used by the project.
+    attr_accessor :cldr_version
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -126,7 +147,14 @@ module Phrase
         :'autotranslate_use_translation_memory' => :'autotranslate_use_translation_memory',
         :'autotranslate_overwrite_unverified_translations' => :'autotranslate_overwrite_unverified_translations',
         :'default_encoding' => :'default_encoding',
-        :'placeholder_styles' => :'placeholder_styles'
+        :'placeholder_styles' => :'placeholder_styles',
+        :'autocomplete_job_enabled' => :'autocomplete_job_enabled',
+        :'job_locking_enabled' => :'job_locking_enabled',
+        :'smart_suggest_enabled' => :'smart_suggest_enabled',
+        :'smart_suggest_use_glossary' => :'smart_suggest_use_glossary',
+        :'smart_suggest_use_machine_translation' => :'smart_suggest_use_machine_translation',
+        :'translation_keys_sort_collation' => :'translation_keys_sort_collation',
+        :'cldr_version' => :'cldr_version'
       }
     end
 
@@ -157,7 +185,14 @@ module Phrase
         :'autotranslate_use_translation_memory' => :'Boolean',
         :'autotranslate_overwrite_unverified_translations' => :'Boolean',
         :'default_encoding' => :'String',
-        :'placeholder_styles' => :'Array<String>'
+        :'placeholder_styles' => :'Array<String>',
+        :'autocomplete_job_enabled' => :'Boolean',
+        :'job_locking_enabled' => :'Boolean',
+        :'smart_suggest_enabled' => :'Boolean',
+        :'smart_suggest_use_glossary' => :'Boolean',
+        :'smart_suggest_use_machine_translation' => :'Boolean',
+        :'translation_keys_sort_collation' => :'String',
+        :'cldr_version' => :'String'
       }
     end
 
@@ -283,6 +318,34 @@ module Phrase
           self.placeholder_styles = value
         end
       end
+
+      if attributes.key?(:'autocomplete_job_enabled')
+        self.autocomplete_job_enabled = attributes[:'autocomplete_job_enabled']
+      end
+
+      if attributes.key?(:'job_locking_enabled')
+        self.job_locking_enabled = attributes[:'job_locking_enabled']
+      end
+
+      if attributes.key?(:'smart_suggest_enabled')
+        self.smart_suggest_enabled = attributes[:'smart_suggest_enabled']
+      end
+
+      if attributes.key?(:'smart_suggest_use_glossary')
+        self.smart_suggest_use_glossary = attributes[:'smart_suggest_use_glossary']
+      end
+
+      if attributes.key?(:'smart_suggest_use_machine_translation')
+        self.smart_suggest_use_machine_translation = attributes[:'smart_suggest_use_machine_translation']
+      end
+
+      if attributes.key?(:'translation_keys_sort_collation')
+        self.translation_keys_sort_collation = attributes[:'translation_keys_sort_collation']
+      end
+
+      if attributes.key?(:'cldr_version')
+        self.cldr_version = attributes[:'cldr_version']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -339,7 +402,14 @@ module Phrase
           autotranslate_use_translation_memory == o.autotranslate_use_translation_memory &&
           autotranslate_overwrite_unverified_translations == o.autotranslate_overwrite_unverified_translations &&
           default_encoding == o.default_encoding &&
-          placeholder_styles == o.placeholder_styles
+          placeholder_styles == o.placeholder_styles &&
+          autocomplete_job_enabled == o.autocomplete_job_enabled &&
+          job_locking_enabled == o.job_locking_enabled &&
+          smart_suggest_enabled == o.smart_suggest_enabled &&
+          smart_suggest_use_glossary == o.smart_suggest_use_glossary &&
+          smart_suggest_use_machine_translation == o.smart_suggest_use_machine_translation &&
+          translation_keys_sort_collation == o.translation_keys_sort_collation &&
+          cldr_version == o.cldr_version
     end
 
     # @see the `==` method
@@ -351,7 +421,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, name, point_of_contact, main_format, media, shares_translation_memory, project_image, remove_project_image, workflow, machine_translation_enabled, enable_branching, protect_master_branch, enable_all_data_type_translation_keys_for_translators, enable_icu_message_format, zero_plural_form_enabled, autotranslate_enabled, autotranslate_check_new_translation_keys, autotranslate_check_new_uploads, autotranslate_check_new_locales, autotranslate_mark_as_unverified, autotranslate_use_machine_translation, autotranslate_use_translation_memory, autotranslate_overwrite_unverified_translations, default_encoding, placeholder_styles].hash
+      [account_id, name, point_of_contact, main_format, media, shares_translation_memory, project_image, remove_project_image, workflow, machine_translation_enabled, enable_branching, protect_master_branch, enable_all_data_type_translation_keys_for_translators, enable_icu_message_format, zero_plural_form_enabled, autotranslate_enabled, autotranslate_check_new_translation_keys, autotranslate_check_new_uploads, autotranslate_check_new_locales, autotranslate_mark_as_unverified, autotranslate_use_machine_translation, autotranslate_use_translation_memory, autotranslate_overwrite_unverified_translations, default_encoding, placeholder_styles, autocomplete_job_enabled, job_locking_enabled, smart_suggest_enabled, smart_suggest_use_glossary, smart_suggest_use_machine_translation, translation_keys_sort_collation, cldr_version].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/release.rb

@@ -20,6 +20,8 @@ module Phrase
 
     attr_accessor :tags
 
+    attr_accessor :state
+
     attr_accessor :project
 
     attr_accessor :created_at
@@ -38,6 +40,7 @@ module Phrase
         :'environments' => :'environments',
         :'locales' => :'locales',
         :'tags' => :'tags',
+        :'state' => :'state',
         :'project' => :'project',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
@@ -56,6 +59,7 @@ module Phrase
         :'environments' => :'Array<String>',
         :'locales' => :'Array<LocalePreview>',
         :'tags' => :'Array<String>',
+        :'state' => :'String',
         :'project' => :'ProjectShort',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime'
@@ -127,6 +131,10 @@ module Phrase
         end
       end
 
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
       if attributes.key?(:'project')
         self.project = attributes[:'project']
       end
@@ -167,6 +175,7 @@ module Phrase
           environments == o.environments &&
           locales == o.locales &&
           tags == o.tags &&
+          state == o.state &&
           project == o.project &&
           created_at == o.created_at &&
           updated_at == o.updated_at
@@ -181,7 +190,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, version, app_min_version, app_max_version, description, platforms, environments, locales, tags, project, created_at, updated_at].hash
+      [id, version, app_min_version, app_max_version, description, platforms, environments, locales, tags, state, project, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/repo_sync.rb

@@ -14,6 +14,9 @@ module Phrase
 
     attr_accessor :repo_name
 
+    # Branch used as the source of exports/PRs. May be `null` when the sync is configured to push directly to `base_branch`. 
+    attr_accessor :pr_branch
+
     attr_accessor :created_at
 
     attr_accessor :last_import_at
@@ -29,6 +32,7 @@ module Phrase
         :'enabled' => :'enabled',
         :'auto_import' => :'auto_import',
         :'repo_name' => :'repo_name',
+        :'pr_branch' => :'pr_branch',
         :'created_at' => :'created_at',
         :'last_import_at' => :'last_import_at',
         :'last_export_at' => :'last_export_at'
@@ -44,6 +48,7 @@ module Phrase
         :'enabled' => :'Boolean',
         :'auto_import' => :'Boolean',
         :'repo_name' => :'String',
+        :'pr_branch' => :'String',
         :'created_at' => :'DateTime',
         :'last_import_at' => :'DateTime',
         :'last_export_at' => :'DateTime'
@@ -53,6 +58,7 @@ module Phrase
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'pr_branch',
       ])
     end
 
@@ -95,6 +101,10 @@ module Phrase
         self.repo_name = attributes[:'repo_name']
       end
 
+      if attributes.key?(:'pr_branch')
+        self.pr_branch = attributes[:'pr_branch']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -132,6 +142,7 @@ module Phrase
           enabled == o.enabled &&
           auto_import == o.auto_import &&
           repo_name == o.repo_name &&
+          pr_branch == o.pr_branch &&
           created_at == o.created_at &&
           last_import_at == o.last_import_at &&
           last_export_at == o.last_export_at
@@ -146,7 +157,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, project, provider, enabled, auto_import, repo_name, created_at, last_import_at, last_export_at].hash
+      [id, project, provider, enabled, auto_import, repo_name, pr_branch, created_at, last_import_at, last_export_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/screenshot_marker.rb

@@ -6,6 +6,7 @@ module Phrase
 
     attr_accessor :presentation
 
+    # Marker presentation style. The default value is `default`. 
     attr_accessor :presentation_type
 
     attr_accessor :created_at
@@ -30,7 +31,7 @@ module Phrase
     def self.openapi_types
       {
         :'id' => :'String',
-        :'presentation' => :'String',
+        :'presentation' => :'ScreenshotMarkerPresentation',
         :'presentation_type' => :'String',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',

data/lib/phrase/models/screenshot_marker_presentation.rb

@@ -0,0 +1,224 @@
+require 'date'
+
+module Phrase
+  # Coordinates and size of the marker on the screenshot, in pixels. 
+  class ScreenshotMarkerPresentation
+    attr_accessor :x
+
+    attr_accessor :y
+
+    attr_accessor :w
+
+    attr_accessor :h
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'x' => :'x',
+        :'y' => :'y',
+        :'w' => :'w',
+        :'h' => :'h'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'x' => :'Integer',
+        :'y' => :'Integer',
+        :'w' => :'Integer',
+        :'h' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::ScreenshotMarkerPresentation` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::ScreenshotMarkerPresentation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'x')
+        self.x = attributes[:'x']
+      end
+
+      if attributes.key?(:'y')
+        self.y = attributes[:'y']
+      end
+
+      if attributes.key?(:'w')
+        self.w = attributes[:'w']
+      end
+
+      if attributes.key?(:'h')
+        self.h = attributes[:'h']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          x == o.x &&
+          y == o.y &&
+          w == o.w &&
+          h == o.h
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [x, y, w, h].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :Time
+        Time.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Phrase.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/phrase/models/search_in_account_parameters.rb

@@ -14,13 +14,17 @@ module Phrase
     # Number of results per page
     attr_accessor :per_page
 
+    # Limit the search to the given project codes. When omitted, the search spans every project the user can access in this account. 
+    attr_accessor :project_ids
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'query' => :'query',
         :'locale_code' => :'locale_code',
         :'page' => :'page',
-        :'per_page' => :'per_page'
+        :'per_page' => :'per_page',
+        :'project_ids' => :'project_ids'
       }
     end
 
@@ -30,7 +34,8 @@ module Phrase
         :'query' => :'String',
         :'locale_code' => :'String',
         :'page' => :'Integer',
-        :'per_page' => :'Integer'
+        :'per_page' => :'Integer',
+        :'project_ids' => :'Array<String>'
       }
     end
 
@@ -70,6 +75,12 @@ module Phrase
       if attributes.key?(:'per_page')
         self.per_page = attributes[:'per_page']
       end
+
+      if attributes.key?(:'project_ids')
+        if (value = attributes[:'project_ids']).is_a?(Array)
+          self.project_ids = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -93,7 +104,8 @@ module Phrase
           query == o.query &&
           locale_code == o.locale_code &&
           page == o.page &&
-          per_page == o.per_page
+          per_page == o.per_page &&
+          project_ids == o.project_ids
     end
 
     # @see the `==` method
@@ -105,7 +117,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [query, locale_code, page, per_page].hash
+      [query, locale_code, page, per_page, project_ids].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/styleguide_create_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
       {
@@ -168,9 +190,45 @@ module Phrase
     # @return true if the model is valid
     def valid?
       return false if @title.nil?
+      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)