phrase 2.20.0 → 2.22.0

data/lib/phrase/models/error_error.rb

@@ -0,0 +1,205 @@
+require 'date'
+
+module Phrase
+  class ErrorError
+    attr_accessor :message
+
+    attr_accessor :code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'message' => :'message',
+        :'code' => :'code'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'message' => :'String',
+        :'code' => :'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::ErrorError` 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::ErrorError`. 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?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      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 &&
+          message == o.message &&
+          code == o.code
+    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
+      [message, code].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_create_parameters.rb

@@ -50,6 +50,9 @@ module Phrase
     # NSStringLocalizedFormatKey attribute. Used in .stringsdict format.
     attr_accessor :localized_format_key
 
+    # Custom metadata property name and value pairs to be associated with key.
+    attr_accessor :custom_metadata
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -68,7 +71,8 @@ module Phrase
         :'xml_space_preserve' => :'xml_space_preserve',
         :'original_file' => :'original_file',
         :'localized_format_string' => :'localized_format_string',
-        :'localized_format_key' => :'localized_format_key'
+        :'localized_format_key' => :'localized_format_key',
+        :'custom_metadata' => :'custom_metadata'
       }
     end
 
@@ -90,7 +94,8 @@ module Phrase
         :'xml_space_preserve' => :'Boolean',
         :'original_file' => :'String',
         :'localized_format_string' => :'String',
-        :'localized_format_key' => :'String'
+        :'localized_format_key' => :'String',
+        :'custom_metadata' => :'Object'
       }
     end
 
@@ -178,6 +183,10 @@ module Phrase
       if attributes.key?(:'localized_format_key')
         self.localized_format_key = attributes[:'localized_format_key']
       end
+
+      if attributes.key?(:'custom_metadata')
+        self.custom_metadata = attributes[:'custom_metadata']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -213,7 +222,8 @@ module Phrase
           xml_space_preserve == o.xml_space_preserve &&
           original_file == o.original_file &&
           localized_format_string == o.localized_format_string &&
-          localized_format_key == o.localized_format_key
+          localized_format_key == o.localized_format_key &&
+          custom_metadata == o.custom_metadata
     end
 
     # @see the `==` method
@@ -225,7 +235,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, description, plural, name_plural, data_type, tags, max_characters_allowed, screenshot, remove_screenshot, unformatted, default_translation_content, xml_space_preserve, original_file, localized_format_string, localized_format_key].hash
+      [branch, name, description, plural, name_plural, data_type, tags, max_characters_allowed, screenshot, remove_screenshot, unformatted, default_translation_content, xml_space_preserve, original_file, localized_format_string, localized_format_key, custom_metadata].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/key_update_parameters.rb

@@ -47,6 +47,9 @@ module Phrase
     # NSStringLocalizedFormatKey attribute. Used in .stringsdict format.
     attr_accessor :localized_format_key
 
+    # Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value.
+    attr_accessor :custom_metadata
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -64,7 +67,8 @@ module Phrase
         :'xml_space_preserve' => :'xml_space_preserve',
         :'original_file' => :'original_file',
         :'localized_format_string' => :'localized_format_string',
-        :'localized_format_key' => :'localized_format_key'
+        :'localized_format_key' => :'localized_format_key',
+        :'custom_metadata' => :'custom_metadata'
       }
     end
 
@@ -85,7 +89,8 @@ module Phrase
         :'xml_space_preserve' => :'Boolean',
         :'original_file' => :'String',
         :'localized_format_string' => :'String',
-        :'localized_format_key' => :'String'
+        :'localized_format_key' => :'String',
+        :'custom_metadata' => :'Object'
       }
     end
 
@@ -169,6 +174,10 @@ module Phrase
       if attributes.key?(:'localized_format_key')
         self.localized_format_key = attributes[:'localized_format_key']
       end
+
+      if attributes.key?(:'custom_metadata')
+        self.custom_metadata = attributes[:'custom_metadata']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -203,7 +212,8 @@ module Phrase
           xml_space_preserve == o.xml_space_preserve &&
           original_file == o.original_file &&
           localized_format_string == o.localized_format_string &&
-          localized_format_key == o.localized_format_key
+          localized_format_key == o.localized_format_key &&
+          custom_metadata == o.custom_metadata
     end
 
     # @see the `==` method
@@ -215,7 +225,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, description, plural, name_plural, data_type, tags, max_characters_allowed, screenshot, remove_screenshot, unformatted, xml_space_preserve, original_file, localized_format_string, localized_format_key].hash
+      [branch, name, description, plural, name_plural, data_type, tags, max_characters_allowed, screenshot, remove_screenshot, unformatted, xml_space_preserve, original_file, localized_format_string, localized_format_key, custom_metadata].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/keys_search_parameters.rb

@@ -11,7 +11,7 @@ module Phrase
     # Order direction. Can be one of: asc, desc.
     attr_accessor :order
 
-    # Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. 
+    # Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name,...</code> for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li>   <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li>   <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li>   <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. 
     attr_accessor :q
 
     # Locale used to determine the translation state of a key when filtering for untranslated or translated keys.

data/lib/phrase/models/locale_report.rb

@@ -0,0 +1,313 @@
+require 'date'
+
+module Phrase
+  class LocaleReport
+    attr_accessor :keys_count
+
+    attr_accessor :translated_translations_percentage
+
+    attr_accessor :unverified_translations_percentage
+
+    attr_accessor :reviewed_translations_percentage
+
+    attr_accessor :untranslated_keys_percentage
+
+    attr_accessor :completed_translations_count
+
+    attr_accessor :untranslated_keys_count
+
+    attr_accessor :unverified_translations_count
+
+    attr_accessor :reviewed_translations_count
+
+    attr_accessor :source_word_count
+
+    attr_accessor :word_count
+
+    attr_accessor :word_count_unverified
+
+    attr_accessor :word_count_missing
+
+    attr_accessor :locale
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'keys_count' => :'keys_count',
+        :'translated_translations_percentage' => :'translated_translations_percentage',
+        :'unverified_translations_percentage' => :'unverified_translations_percentage',
+        :'reviewed_translations_percentage' => :'reviewed_translations_percentage',
+        :'untranslated_keys_percentage' => :'untranslated_keys_percentage',
+        :'completed_translations_count' => :'completed_translations_count',
+        :'untranslated_keys_count' => :'untranslated_keys_count',
+        :'unverified_translations_count' => :'unverified_translations_count',
+        :'reviewed_translations_count' => :'reviewed_translations_count',
+        :'source_word_count' => :'source_word_count',
+        :'word_count' => :'word_count',
+        :'word_count_unverified' => :'word_count_unverified',
+        :'word_count_missing' => :'word_count_missing',
+        :'locale' => :'locale'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'keys_count' => :'Integer',
+        :'translated_translations_percentage' => :'Integer',
+        :'unverified_translations_percentage' => :'Integer',
+        :'reviewed_translations_percentage' => :'Integer',
+        :'untranslated_keys_percentage' => :'Integer',
+        :'completed_translations_count' => :'Integer',
+        :'untranslated_keys_count' => :'Integer',
+        :'unverified_translations_count' => :'Integer',
+        :'reviewed_translations_count' => :'Integer',
+        :'source_word_count' => :'Integer',
+        :'word_count' => :'Integer',
+        :'word_count_unverified' => :'Integer',
+        :'word_count_missing' => :'Integer',
+        :'locale' => :'LocalePreview'
+      }
+    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::LocaleReport` 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::LocaleReport`. 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?(:'keys_count')
+        self.keys_count = attributes[:'keys_count']
+      end
+
+      if attributes.key?(:'translated_translations_percentage')
+        self.translated_translations_percentage = attributes[:'translated_translations_percentage']
+      end
+
+      if attributes.key?(:'unverified_translations_percentage')
+        self.unverified_translations_percentage = attributes[:'unverified_translations_percentage']
+      end
+
+      if attributes.key?(:'reviewed_translations_percentage')
+        self.reviewed_translations_percentage = attributes[:'reviewed_translations_percentage']
+      end
+
+      if attributes.key?(:'untranslated_keys_percentage')
+        self.untranslated_keys_percentage = attributes[:'untranslated_keys_percentage']
+      end
+
+      if attributes.key?(:'completed_translations_count')
+        self.completed_translations_count = attributes[:'completed_translations_count']
+      end
+
+      if attributes.key?(:'untranslated_keys_count')
+        self.untranslated_keys_count = attributes[:'untranslated_keys_count']
+      end
+
+      if attributes.key?(:'unverified_translations_count')
+        self.unverified_translations_count = attributes[:'unverified_translations_count']
+      end
+
+      if attributes.key?(:'reviewed_translations_count')
+        self.reviewed_translations_count = attributes[:'reviewed_translations_count']
+      end
+
+      if attributes.key?(:'source_word_count')
+        self.source_word_count = attributes[:'source_word_count']
+      end
+
+      if attributes.key?(:'word_count')
+        self.word_count = attributes[:'word_count']
+      end
+
+      if attributes.key?(:'word_count_unverified')
+        self.word_count_unverified = attributes[:'word_count_unverified']
+      end
+
+      if attributes.key?(:'word_count_missing')
+        self.word_count_missing = attributes[:'word_count_missing']
+      end
+
+      if attributes.key?(:'locale')
+        self.locale = attributes[:'locale']
+      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 &&
+          keys_count == o.keys_count &&
+          translated_translations_percentage == o.translated_translations_percentage &&
+          unverified_translations_percentage == o.unverified_translations_percentage &&
+          reviewed_translations_percentage == o.reviewed_translations_percentage &&
+          untranslated_keys_percentage == o.untranslated_keys_percentage &&
+          completed_translations_count == o.completed_translations_count &&
+          untranslated_keys_count == o.untranslated_keys_count &&
+          unverified_translations_count == o.unverified_translations_count &&
+          reviewed_translations_count == o.reviewed_translations_count &&
+          source_word_count == o.source_word_count &&
+          word_count == o.word_count &&
+          word_count_unverified == o.word_count_unverified &&
+          word_count_missing == o.word_count_missing &&
+          locale == o.locale
+    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
+      [keys_count, translated_translations_percentage, unverified_translations_percentage, reviewed_translations_percentage, untranslated_keys_percentage, completed_translations_count, untranslated_keys_count, unverified_translations_count, reviewed_translations_count, source_word_count, word_count, word_count_unverified, word_count_missing, locale].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