weblate 0.1.0

data/lib/weblate/models/unit.rb

@@ -0,0 +1,757 @@
+=begin
+#Weblate's REST API
+
+# The API is accessible on the ``/api/`` URL and it is based on [Django REST framework](https://www.django-rest-framework.org/).  The OpenAPI specification is available as feature preview, feedback welcome!     
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Weblate
+  class Unit
+    attr_accessor :translation
+
+    attr_accessor :source
+
+    attr_accessor :previous_source
+
+    attr_accessor :target
+
+    attr_accessor :id_hash
+
+    attr_accessor :content_hash
+
+    attr_accessor :location
+
+    attr_accessor :context
+
+    attr_accessor :note
+
+    attr_accessor :flags
+
+    attr_accessor :labels
+
+    attr_accessor :state
+
+    attr_accessor :fuzzy
+
+    attr_accessor :translated
+
+    attr_accessor :approved
+
+    attr_accessor :position
+
+    attr_accessor :has_suggestion
+
+    attr_accessor :has_comment
+
+    attr_accessor :has_failing_check
+
+    attr_accessor :num_words
+
+    attr_accessor :source_unit
+
+    attr_accessor :priority
+
+    attr_accessor :id
+
+    attr_accessor :web_url
+
+    attr_accessor :url
+
+    # Additional explanation to clarify meaning or usage of the string.
+    attr_accessor :explanation
+
+    # Additional comma-separated flags to influence Weblate behavior.
+    attr_accessor :extra_flags
+
+    attr_accessor :pending
+
+    attr_accessor :timestamp
+
+    attr_accessor :last_updated
+
+    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
+      {
+        :'translation' => :'translation',
+        :'source' => :'source',
+        :'previous_source' => :'previous_source',
+        :'target' => :'target',
+        :'id_hash' => :'id_hash',
+        :'content_hash' => :'content_hash',
+        :'location' => :'location',
+        :'context' => :'context',
+        :'note' => :'note',
+        :'flags' => :'flags',
+        :'labels' => :'labels',
+        :'state' => :'state',
+        :'fuzzy' => :'fuzzy',
+        :'translated' => :'translated',
+        :'approved' => :'approved',
+        :'position' => :'position',
+        :'has_suggestion' => :'has_suggestion',
+        :'has_comment' => :'has_comment',
+        :'has_failing_check' => :'has_failing_check',
+        :'num_words' => :'num_words',
+        :'source_unit' => :'source_unit',
+        :'priority' => :'priority',
+        :'id' => :'id',
+        :'web_url' => :'web_url',
+        :'url' => :'url',
+        :'explanation' => :'explanation',
+        :'extra_flags' => :'extra_flags',
+        :'pending' => :'pending',
+        :'timestamp' => :'timestamp',
+        :'last_updated' => :'last_updated'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'translation' => :'String',
+        :'source' => :'Array<String>',
+        :'previous_source' => :'String',
+        :'target' => :'Array<String>',
+        :'id_hash' => :'Integer',
+        :'content_hash' => :'Integer',
+        :'location' => :'String',
+        :'context' => :'String',
+        :'note' => :'String',
+        :'flags' => :'String',
+        :'labels' => :'Array<UnitLabels>',
+        :'state' => :'StateEnum',
+        :'fuzzy' => :'Boolean',
+        :'translated' => :'Boolean',
+        :'approved' => :'Boolean',
+        :'position' => :'Integer',
+        :'has_suggestion' => :'Boolean',
+        :'has_comment' => :'Boolean',
+        :'has_failing_check' => :'Boolean',
+        :'num_words' => :'Integer',
+        :'source_unit' => :'String',
+        :'priority' => :'Integer',
+        :'id' => :'Integer',
+        :'web_url' => :'String',
+        :'url' => :'String',
+        :'explanation' => :'String',
+        :'extra_flags' => :'String',
+        :'pending' => :'Boolean',
+        :'timestamp' => :'Time',
+        :'last_updated' => :'Time'
+      }
+    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 `Weblate::Unit` 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 `Weblate::Unit`. 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?(:'translation')
+        self.translation = attributes[:'translation']
+      else
+        self.translation = nil
+      end
+
+      if attributes.key?(:'source')
+        if (value = attributes[:'source']).is_a?(Array)
+          self.source = value
+        end
+      else
+        self.source = nil
+      end
+
+      if attributes.key?(:'previous_source')
+        self.previous_source = attributes[:'previous_source']
+      end
+
+      if attributes.key?(:'target')
+        if (value = attributes[:'target']).is_a?(Array)
+          self.target = value
+        end
+      else
+        self.target = nil
+      end
+
+      if attributes.key?(:'id_hash')
+        self.id_hash = attributes[:'id_hash']
+      else
+        self.id_hash = nil
+      end
+
+      if attributes.key?(:'content_hash')
+        self.content_hash = attributes[:'content_hash']
+      else
+        self.content_hash = nil
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'context')
+        self.context = attributes[:'context']
+      end
+
+      if attributes.key?(:'note')
+        self.note = attributes[:'note']
+      end
+
+      if attributes.key?(:'flags')
+        self.flags = attributes[:'flags']
+      end
+
+      if attributes.key?(:'labels')
+        if (value = attributes[:'labels']).is_a?(Array)
+          self.labels = value
+        end
+      else
+        self.labels = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'fuzzy')
+        self.fuzzy = attributes[:'fuzzy']
+      else
+        self.fuzzy = nil
+      end
+
+      if attributes.key?(:'translated')
+        self.translated = attributes[:'translated']
+      else
+        self.translated = nil
+      end
+
+      if attributes.key?(:'approved')
+        self.approved = attributes[:'approved']
+      else
+        self.approved = nil
+      end
+
+      if attributes.key?(:'position')
+        self.position = attributes[:'position']
+      else
+        self.position = nil
+      end
+
+      if attributes.key?(:'has_suggestion')
+        self.has_suggestion = attributes[:'has_suggestion']
+      else
+        self.has_suggestion = nil
+      end
+
+      if attributes.key?(:'has_comment')
+        self.has_comment = attributes[:'has_comment']
+      else
+        self.has_comment = nil
+      end
+
+      if attributes.key?(:'has_failing_check')
+        self.has_failing_check = attributes[:'has_failing_check']
+      else
+        self.has_failing_check = nil
+      end
+
+      if attributes.key?(:'num_words')
+        self.num_words = attributes[:'num_words']
+      end
+
+      if attributes.key?(:'source_unit')
+        self.source_unit = attributes[:'source_unit']
+      else
+        self.source_unit = nil
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'web_url')
+        self.web_url = attributes[:'web_url']
+      else
+        self.web_url = nil
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = nil
+      end
+
+      if attributes.key?(:'explanation')
+        self.explanation = attributes[:'explanation']
+      end
+
+      if attributes.key?(:'extra_flags')
+        self.extra_flags = attributes[:'extra_flags']
+      end
+
+      if attributes.key?(:'pending')
+        self.pending = attributes[:'pending']
+      else
+        self.pending = nil
+      end
+
+      if attributes.key?(:'timestamp')
+        self.timestamp = attributes[:'timestamp']
+      else
+        self.timestamp = nil
+      end
+
+      if attributes.key?(:'last_updated')
+        self.last_updated = attributes[:'last_updated']
+      else
+        self.last_updated = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @translation.nil?
+        invalid_properties.push('invalid value for "translation", translation cannot be nil.')
+      end
+
+      if @source.nil?
+        invalid_properties.push('invalid value for "source", source cannot be nil.')
+      end
+
+      if @target.nil?
+        invalid_properties.push('invalid value for "target", target cannot be nil.')
+      end
+
+      if @id_hash.nil?
+        invalid_properties.push('invalid value for "id_hash", id_hash cannot be nil.')
+      end
+
+      if @id_hash > 9223372036854775807
+        invalid_properties.push('invalid value for "id_hash", must be smaller than or equal to 9223372036854775807.')
+      end
+
+      if @id_hash < -9223372036854775808
+        invalid_properties.push('invalid value for "id_hash", must be greater than or equal to -9223372036854775808.')
+      end
+
+      if @content_hash.nil?
+        invalid_properties.push('invalid value for "content_hash", content_hash cannot be nil.')
+      end
+
+      if @labels.nil?
+        invalid_properties.push('invalid value for "labels", labels cannot be nil.')
+      end
+
+      if @fuzzy.nil?
+        invalid_properties.push('invalid value for "fuzzy", fuzzy cannot be nil.')
+      end
+
+      if @translated.nil?
+        invalid_properties.push('invalid value for "translated", translated cannot be nil.')
+      end
+
+      if @approved.nil?
+        invalid_properties.push('invalid value for "approved", approved cannot be nil.')
+      end
+
+      if @position.nil?
+        invalid_properties.push('invalid value for "position", position cannot be nil.')
+      end
+
+      if @position > 2147483647
+        invalid_properties.push('invalid value for "position", must be smaller than or equal to 2147483647.')
+      end
+
+      if @position < -2147483648
+        invalid_properties.push('invalid value for "position", must be greater than or equal to -2147483648.')
+      end
+
+      if @has_suggestion.nil?
+        invalid_properties.push('invalid value for "has_suggestion", has_suggestion cannot be nil.')
+      end
+
+      if @has_comment.nil?
+        invalid_properties.push('invalid value for "has_comment", has_comment cannot be nil.')
+      end
+
+      if @has_failing_check.nil?
+        invalid_properties.push('invalid value for "has_failing_check", has_failing_check cannot be nil.')
+      end
+
+      if !@num_words.nil? && @num_words > 2147483647
+        invalid_properties.push('invalid value for "num_words", must be smaller than or equal to 2147483647.')
+      end
+
+      if !@num_words.nil? && @num_words < -2147483648
+        invalid_properties.push('invalid value for "num_words", must be greater than or equal to -2147483648.')
+      end
+
+      if @source_unit.nil?
+        invalid_properties.push('invalid value for "source_unit", source_unit cannot be nil.')
+      end
+
+      if !@priority.nil? && @priority > 2147483647
+        invalid_properties.push('invalid value for "priority", must be smaller than or equal to 2147483647.')
+      end
+
+      if !@priority.nil? && @priority < -2147483648
+        invalid_properties.push('invalid value for "priority", must be greater than or equal to -2147483648.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @web_url.nil?
+        invalid_properties.push('invalid value for "web_url", web_url cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @pending.nil?
+        invalid_properties.push('invalid value for "pending", pending cannot be nil.')
+      end
+
+      if @timestamp.nil?
+        invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.')
+      end
+
+      if @last_updated.nil?
+        invalid_properties.push('invalid value for "last_updated", last_updated cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @translation.nil?
+      return false if @source.nil?
+      return false if @target.nil?
+      return false if @id_hash.nil?
+      return false if @id_hash > 9223372036854775807
+      return false if @id_hash < -9223372036854775808
+      return false if @content_hash.nil?
+      return false if @labels.nil?
+      return false if @fuzzy.nil?
+      return false if @translated.nil?
+      return false if @approved.nil?
+      return false if @position.nil?
+      return false if @position > 2147483647
+      return false if @position < -2147483648
+      return false if @has_suggestion.nil?
+      return false if @has_comment.nil?
+      return false if @has_failing_check.nil?
+      return false if !@num_words.nil? && @num_words > 2147483647
+      return false if !@num_words.nil? && @num_words < -2147483648
+      return false if @source_unit.nil?
+      return false if !@priority.nil? && @priority > 2147483647
+      return false if !@priority.nil? && @priority < -2147483648
+      return false if @id.nil?
+      return false if @web_url.nil?
+      return false if @url.nil?
+      return false if @pending.nil?
+      return false if @timestamp.nil?
+      return false if @last_updated.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id_hash Value to be assigned
+    def id_hash=(id_hash)
+      if id_hash.nil?
+        fail ArgumentError, 'id_hash cannot be nil'
+      end
+
+      if id_hash > 9223372036854775807
+        fail ArgumentError, 'invalid value for "id_hash", must be smaller than or equal to 9223372036854775807.'
+      end
+
+      if id_hash < -9223372036854775808
+        fail ArgumentError, 'invalid value for "id_hash", must be greater than or equal to -9223372036854775808.'
+      end
+
+      @id_hash = id_hash
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] position Value to be assigned
+    def position=(position)
+      if position.nil?
+        fail ArgumentError, 'position cannot be nil'
+      end
+
+      if position > 2147483647
+        fail ArgumentError, 'invalid value for "position", must be smaller than or equal to 2147483647.'
+      end
+
+      if position < -2147483648
+        fail ArgumentError, 'invalid value for "position", must be greater than or equal to -2147483648.'
+      end
+
+      @position = position
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] num_words Value to be assigned
+    def num_words=(num_words)
+      if num_words.nil?
+        fail ArgumentError, 'num_words cannot be nil'
+      end
+
+      if num_words > 2147483647
+        fail ArgumentError, 'invalid value for "num_words", must be smaller than or equal to 2147483647.'
+      end
+
+      if num_words < -2147483648
+        fail ArgumentError, 'invalid value for "num_words", must be greater than or equal to -2147483648.'
+      end
+
+      @num_words = num_words
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] priority Value to be assigned
+    def priority=(priority)
+      if priority.nil?
+        fail ArgumentError, 'priority cannot be nil'
+      end
+
+      if priority > 2147483647
+        fail ArgumentError, 'invalid value for "priority", must be smaller than or equal to 2147483647.'
+      end
+
+      if priority < -2147483648
+        fail ArgumentError, 'invalid value for "priority", must be greater than or equal to -2147483648.'
+      end
+
+      @priority = priority
+    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 &&
+          translation == o.translation &&
+          source == o.source &&
+          previous_source == o.previous_source &&
+          target == o.target &&
+          id_hash == o.id_hash &&
+          content_hash == o.content_hash &&
+          location == o.location &&
+          context == o.context &&
+          note == o.note &&
+          flags == o.flags &&
+          labels == o.labels &&
+          state == o.state &&
+          fuzzy == o.fuzzy &&
+          translated == o.translated &&
+          approved == o.approved &&
+          position == o.position &&
+          has_suggestion == o.has_suggestion &&
+          has_comment == o.has_comment &&
+          has_failing_check == o.has_failing_check &&
+          num_words == o.num_words &&
+          source_unit == o.source_unit &&
+          priority == o.priority &&
+          id == o.id &&
+          web_url == o.web_url &&
+          url == o.url &&
+          explanation == o.explanation &&
+          extra_flags == o.extra_flags &&
+          pending == o.pending &&
+          timestamp == o.timestamp &&
+          last_updated == o.last_updated
+    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
+      [translation, source, previous_source, target, id_hash, content_hash, location, context, note, flags, labels, state, fuzzy, translated, approved, position, has_suggestion, has_comment, has_failing_check, num_words, source_unit, priority, id, web_url, url, explanation, extra_flags, pending, timestamp, last_updated].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.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
+        # models (e.g. Pet) or oneOf
+        klass = Weblate.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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