phrase 4.24.0 → 4.26.0

data/lib/phrase/models/key_format_annotations_list200_response_inner.rb

@@ -0,0 +1,207 @@
+require 'date'
+
+module Phrase
+  class KeyFormatAnnotationsList200ResponseInner
+    # The file format that produced this annotation. 
+    attr_accessor :file_format
+
+    # The original file-format snippet captured when the key was imported. Returned as-is, may contain multi-line content. 
+    attr_accessor :original_representation
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'file_format' => :'file_format',
+        :'original_representation' => :'original_representation'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'file_format' => :'String',
+        :'original_representation' => :'String'
+      }
+    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::KeyFormatAnnotationsList200ResponseInner` 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::KeyFormatAnnotationsList200ResponseInner`. 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?(:'file_format')
+        self.file_format = attributes[:'file_format']
+      end
+
+      if attributes.key?(:'original_representation')
+        self.original_representation = attributes[:'original_representation']
+      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 &&
+          file_format == o.file_format &&
+          original_representation == o.original_representation
+    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
+      [file_format, original_representation].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/key_links_batch_destroy_parameters.rb

@@ -2,17 +2,43 @@ require 'date'
 
 module Phrase
   class KeyLinksBatchDestroyParameters
-    # The IDs of the child keys to unlink from the parent key.
+    # Codes of the child keys to unlink. Required when unlink_parent is false or omitted. Ignored when unlink_parent is true.
     attr_accessor :child_key_ids
 
-    # Whether to unlink the parent key as well and unmark it as linked-key.
+    # When true, dissolves the entire linked-key group by unlinking all children and removing the group. The child_key_ids field is ignored when this is set to true.
     attr_accessor :unlink_parent
 
+    # Controls what happens to child key translation content after unlinking. keep_content (default) copies the parent translation into each child; remove_content clears each child translation.
+    attr_accessor :strategy
+
+    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
       {
         :'child_key_ids' => :'child_key_ids',
-        :'unlink_parent' => :'unlink_parent'
+        :'unlink_parent' => :'unlink_parent',
+        :'strategy' => :'strategy'
       }
     end
 
@@ -20,7 +46,8 @@ module Phrase
     def self.openapi_types
       {
         :'child_key_ids' => :'Array<String>',
-        :'unlink_parent' => :'Boolean'
+        :'unlink_parent' => :'Boolean',
+        :'strategy' => :'String'
       }
     end
 
@@ -56,6 +83,12 @@ module Phrase
       else
         self.unlink_parent = false
       end
+
+      if attributes.key?(:'strategy')
+        self.strategy = attributes[:'strategy']
+      else
+        self.strategy = 'keep_content'
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -73,16 +106,29 @@ module Phrase
     # @return true if the model is valid
     def valid?
       return false if @child_key_ids.nil?
+      strategy_validator = EnumAttributeValidator.new('String', ["keep_content", "remove_content"])
+      return false unless strategy_validator.valid?(@strategy)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] strategy Object to be assigned
+    def strategy=(strategy)
+      validator = EnumAttributeValidator.new('String', ["keep_content", "remove_content"])
+      unless validator.valid?(strategy)
+        fail ArgumentError, "invalid value for \"strategy\", must be one of #{validator.allowable_values}."
+      end
+      @strategy = strategy
+    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 &&
           child_key_ids == o.child_key_ids &&
-          unlink_parent == o.unlink_parent
+          unlink_parent == o.unlink_parent &&
+          strategy == o.strategy
     end
 
     # @see the `==` method
@@ -94,7 +140,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [child_key_ids, unlink_parent].hash
+      [child_key_ids, unlink_parent, strategy].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/key_links_create_parameters.rb

@@ -2,7 +2,7 @@ require 'date'
 
 module Phrase
   class KeyLinksCreateParameters
-    # The IDs of the child keys to link to the parent key. Can be left empty, to only mark the given translation-key as parent
+    # Codes of the keys to link as children. Pass an empty array to mark the parent key without linking any children.
     attr_accessor :child_key_ids
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/phrase/models/locale.rb

@@ -22,6 +22,8 @@ module Phrase
 
     attr_accessor :fallback_locale
 
+    attr_accessor :language_ai_profile
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -39,6 +41,7 @@ module Phrase
         :'ordinal_plural_forms' => :'ordinal_plural_forms',
         :'source_locale' => :'source_locale',
         :'fallback_locale' => :'fallback_locale',
+        :'language_ai_profile' => :'language_ai_profile',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
       }
@@ -57,6 +60,7 @@ module Phrase
         :'ordinal_plural_forms' => :'Array<String>',
         :'source_locale' => :'LocalePreview',
         :'fallback_locale' => :'LocalePreview',
+        :'language_ai_profile' => :'String',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime'
       }
@@ -127,6 +131,10 @@ module Phrase
         self.fallback_locale = attributes[:'fallback_locale']
       end
 
+      if attributes.key?(:'language_ai_profile')
+        self.language_ai_profile = attributes[:'language_ai_profile']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -164,6 +172,7 @@ module Phrase
           ordinal_plural_forms == o.ordinal_plural_forms &&
           source_locale == o.source_locale &&
           fallback_locale == o.fallback_locale &&
+          language_ai_profile == o.language_ai_profile &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -177,7 +186,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, code, default, main, rtl, plural_forms, ordinal_plural_forms, source_locale, fallback_locale, created_at, updated_at].hash
+      [id, name, code, default, main, rtl, plural_forms, ordinal_plural_forms, source_locale, fallback_locale, language_ai_profile, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/locale_create_parameters.rb

@@ -35,6 +35,9 @@ module Phrase
     # If set, translations for this locale will be fetched automatically, right after creation.
     attr_accessor :autotranslate
 
+    # Identifier of the Language AI profile to use for this locale.
+    attr_accessor :language_ai_profile
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +51,8 @@ module Phrase
         :'fallback_locale_id' => :'fallback_locale_id',
         :'unverify_new_translations' => :'unverify_new_translations',
         :'unverify_updated_translations' => :'unverify_updated_translations',
-        :'autotranslate' => :'autotranslate'
+        :'autotranslate' => :'autotranslate',
+        :'language_ai_profile' => :'language_ai_profile'
       }
     end
 
@@ -65,7 +69,8 @@ module Phrase
         :'fallback_locale_id' => :'String',
         :'unverify_new_translations' => :'Boolean',
         :'unverify_updated_translations' => :'Boolean',
-        :'autotranslate' => :'Boolean'
+        :'autotranslate' => :'Boolean',
+        :'language_ai_profile' => :'String'
       }
     end
 
@@ -133,6 +138,10 @@ module Phrase
       if attributes.key?(:'autotranslate')
         self.autotranslate = attributes[:'autotranslate']
       end
+
+      if attributes.key?(:'language_ai_profile')
+        self.language_ai_profile = attributes[:'language_ai_profile']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -173,7 +182,8 @@ module Phrase
           fallback_locale_id == o.fallback_locale_id &&
           unverify_new_translations == o.unverify_new_translations &&
           unverify_updated_translations == o.unverify_updated_translations &&
-          autotranslate == o.autotranslate
+          autotranslate == o.autotranslate &&
+          language_ai_profile == o.language_ai_profile
     end
 
     # @see the `==` method
@@ -185,7 +195,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, code, default, main, rtl, source_locale_id, fallback_locale_id, unverify_new_translations, unverify_updated_translations, autotranslate].hash
+      [branch, name, code, default, main, rtl, source_locale_id, fallback_locale_id, unverify_new_translations, unverify_updated_translations, autotranslate, language_ai_profile].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/locale_details.rb

@@ -22,6 +22,8 @@ module Phrase
 
     attr_accessor :fallback_locale
 
+    attr_accessor :language_ai_profile
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -41,6 +43,7 @@ module Phrase
         :'ordinal_plural_forms' => :'ordinal_plural_forms',
         :'source_locale' => :'source_locale',
         :'fallback_locale' => :'fallback_locale',
+        :'language_ai_profile' => :'language_ai_profile',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
         :'statistics' => :'statistics'
@@ -60,6 +63,7 @@ module Phrase
         :'ordinal_plural_forms' => :'Array<String>',
         :'source_locale' => :'LocalePreview',
         :'fallback_locale' => :'LocalePreview',
+        :'language_ai_profile' => :'String',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
         :'statistics' => :'LocaleStatistics'
@@ -138,6 +142,10 @@ module Phrase
         self.fallback_locale = attributes[:'fallback_locale']
       end
 
+      if attributes.key?(:'language_ai_profile')
+        self.language_ai_profile = attributes[:'language_ai_profile']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -179,6 +187,7 @@ module Phrase
           ordinal_plural_forms == o.ordinal_plural_forms &&
           source_locale == o.source_locale &&
           fallback_locale == o.fallback_locale &&
+          language_ai_profile == o.language_ai_profile &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           statistics == o.statistics
@@ -193,7 +202,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, code, default, main, rtl, plural_forms, ordinal_plural_forms, source_locale, fallback_locale, created_at, updated_at, statistics].hash
+      [id, name, code, default, main, rtl, plural_forms, ordinal_plural_forms, source_locale, fallback_locale, language_ai_profile, created_at, updated_at, statistics].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/locale_download_create_parameters.rb

@@ -53,6 +53,12 @@ module Phrase
     # Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. 
     attr_accessor :custom_metadata_filters
 
+    # Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed.
+    attr_accessor :translation_key_prefix
+
+    # Only download translation keys containing the prefix specified by `translation_key_prefix`, and remove that prefix from the generated file. Requires `translation_key_prefix` to be set.
+    attr_accessor :filter_by_prefix
+
     # Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`). 
     attr_accessor :updated_since
 
@@ -76,6 +82,8 @@ module Phrase
         :'fallback_for_unverified_translations' => :'fallback_for_unverified_translations',
         :'source_locale_id' => :'source_locale_id',
         :'custom_metadata_filters' => :'custom_metadata_filters',
+        :'translation_key_prefix' => :'translation_key_prefix',
+        :'filter_by_prefix' => :'filter_by_prefix',
         :'updated_since' => :'updated_since'
       }
     end
@@ -100,6 +108,8 @@ module Phrase
         :'fallback_for_unverified_translations' => :'Boolean',
         :'source_locale_id' => :'String',
         :'custom_metadata_filters' => :'Object',
+        :'translation_key_prefix' => :'String',
+        :'filter_by_prefix' => :'Boolean',
         :'updated_since' => :'String'
       }
     end
@@ -195,6 +205,14 @@ module Phrase
         self.custom_metadata_filters = attributes[:'custom_metadata_filters']
       end
 
+      if attributes.key?(:'translation_key_prefix')
+        self.translation_key_prefix = attributes[:'translation_key_prefix']
+      end
+
+      if attributes.key?(:'filter_by_prefix')
+        self.filter_by_prefix = attributes[:'filter_by_prefix']
+      end
+
       if attributes.key?(:'updated_since')
         self.updated_since = attributes[:'updated_since']
       end
@@ -240,6 +258,8 @@ module Phrase
           fallback_for_unverified_translations == o.fallback_for_unverified_translations &&
           source_locale_id == o.source_locale_id &&
           custom_metadata_filters == o.custom_metadata_filters &&
+          translation_key_prefix == o.translation_key_prefix &&
+          filter_by_prefix == o.filter_by_prefix &&
           updated_since == o.updated_since
     end
 
@@ -252,7 +272,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [file_format, branch, tags, include_empty_translations, exclude_empty_zero_forms, include_translated_keys, keep_notranslate_tags, format_options, encoding, include_unverified_translations, use_last_reviewed_version, locale_ids, fallback_locale_id, use_locale_fallback, fallback_for_unverified_translations, source_locale_id, custom_metadata_filters, updated_since].hash
+      [file_format, branch, tags, include_empty_translations, exclude_empty_zero_forms, include_translated_keys, keep_notranslate_tags, format_options, encoding, include_unverified_translations, use_last_reviewed_version, locale_ids, fallback_locale_id, use_locale_fallback, fallback_for_unverified_translations, source_locale_id, custom_metadata_filters, translation_key_prefix, filter_by_prefix, updated_since].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/locale_update_parameters.rb

@@ -35,6 +35,9 @@ module Phrase
     # If set, translations for this locale will be fetched automatically, right after creation.
     attr_accessor :autotranslate
 
+    # Identifier of the Language AI profile to use for this locale.
+    attr_accessor :language_ai_profile
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +51,8 @@ module Phrase
         :'fallback_locale_id' => :'fallback_locale_id',
         :'unverify_new_translations' => :'unverify_new_translations',
         :'unverify_updated_translations' => :'unverify_updated_translations',
-        :'autotranslate' => :'autotranslate'
+        :'autotranslate' => :'autotranslate',
+        :'language_ai_profile' => :'language_ai_profile'
       }
     end
 
@@ -65,7 +69,8 @@ module Phrase
         :'fallback_locale_id' => :'String',
         :'unverify_new_translations' => :'Boolean',
         :'unverify_updated_translations' => :'Boolean',
-        :'autotranslate' => :'Boolean'
+        :'autotranslate' => :'Boolean',
+        :'language_ai_profile' => :'String'
       }
     end
 
@@ -133,6 +138,10 @@ module Phrase
       if attributes.key?(:'autotranslate')
         self.autotranslate = attributes[:'autotranslate']
       end
+
+      if attributes.key?(:'language_ai_profile')
+        self.language_ai_profile = attributes[:'language_ai_profile']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -163,7 +172,8 @@ module Phrase
           fallback_locale_id == o.fallback_locale_id &&
           unverify_new_translations == o.unverify_new_translations &&
           unverify_updated_translations == o.unverify_updated_translations &&
-          autotranslate == o.autotranslate
+          autotranslate == o.autotranslate &&
+          language_ai_profile == o.language_ai_profile
     end
 
     # @see the `==` method
@@ -175,7 +185,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, code, default, main, rtl, source_locale_id, fallback_locale_id, unverify_new_translations, unverify_updated_translations, autotranslate].hash
+      [branch, name, code, default, main, rtl, source_locale_id, fallback_locale_id, unverify_new_translations, unverify_updated_translations, autotranslate, language_ai_profile].hash
     end
 
     # Builds the object from hash