words_ruby_sdk 18.6

data/lib/words_ruby_sdk/models/graphics_quality_options_data.rb

@@ -0,0 +1,358 @@
+
+require 'date'
+
+module WordsRubySdk
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="GraphicsQualityOptionsData.rb">
+ #   Copyright (c) 2017 Aspose.Words for Cloud
+ # </copyright>
+ # <summary>
+ #   Permission is hereby granted, free of charge, to any person obtaining a copy
+ #  of this software and associated documentation files (the "Software"), to deal
+ #  in the Software without restriction, including without limitation the rights
+ #  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #  copies of the Software, and to permit persons to whom the Software is
+ #  furnished to do so, subject to the following conditions:
+ #
+ #  The above copyright notice and this permission notice shall be included in all
+ #  copies or substantial portions of the Software.
+ #
+ #  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ #  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #  SOFTWARE.
+ # </summary>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+  # Allows to specify additional System.Drawing.Graphics quality options.
+  class GraphicsQualityOptionsData
+    # Gets or sets a value that specifies how composited images are drawn to this Graphics.
+    attr_accessor :compositing_mode
+
+    # Gets or sets the rendering quality of composited images drawn to this Graphics.
+    attr_accessor :compositing_quality
+
+    # Gets or sets the interpolation mode associated with this Graphics.
+    attr_accessor :interpolation_mode
+
+    # Gets or sets the rendering quality for this Graphics.
+    attr_accessor :smoothing_mode
+
+    # Gets or sets text layout information (such as alignment, orientation and tab stops) display manipulations (such as ellipsis insertion and national digit substitution) and OpenType features.
+    attr_accessor :string_format
+
+    # Gets or sets the rendering mode for text associated with this Graphics.
+    attr_accessor :text_rendering_hint
+
+    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
+      {
+        :'compositing_mode' => :'CompositingMode',
+        :'compositing_quality' => :'CompositingQuality',
+        :'interpolation_mode' => :'InterpolationMode',
+        :'smoothing_mode' => :'SmoothingMode',
+        :'string_format' => :'StringFormat',
+        :'text_rendering_hint' => :'TextRenderingHint'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'compositing_mode' => :'String',
+        :'compositing_quality' => :'String',
+        :'interpolation_mode' => :'String',
+        :'smoothing_mode' => :'String',
+        :'string_format' => :'StringFormatData',
+        :'text_rendering_hint' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.key?(:'CompositingMode')
+        self.compositing_mode = attributes[:'CompositingMode']
+      end
+
+      if attributes.key?(:'CompositingQuality')
+        self.compositing_quality = attributes[:'CompositingQuality']
+      end
+
+      if attributes.key?(:'InterpolationMode')
+        self.interpolation_mode = attributes[:'InterpolationMode']
+      end
+
+      if attributes.key?(:'SmoothingMode')
+        self.smoothing_mode = attributes[:'SmoothingMode']
+      end
+
+      if attributes.key?(:'StringFormat')
+        self.string_format = attributes[:'StringFormat']
+      end
+
+      if attributes.key?(:'TextRenderingHint')
+        self.text_rendering_hint = attributes[:'TextRenderingHint']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = []
+      return 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?
+      compositing_mode_validator = EnumAttributeValidator.new('String', %w["SourceOver", "SourceCopy"])
+      return false unless compositing_mode_validator.valid?(@compositing_mode)
+      compositing_quality_validator = EnumAttributeValidator.new('String', %w["Default", "HighSpeed", "HighQuality", "GammaCorrected", "AssumeLinear", "Invalid"])
+      return false unless compositing_quality_validator.valid?(@compositing_quality)
+      interpolation_mode_validator = EnumAttributeValidator.new('String', %w["Default", "Low", "High", "Bilinear", "Bicubic", "NearestNeighbor", "HighQualityBilinear", "HighQualityBicubic", "Invalid"])
+      return false unless interpolation_mode_validator.valid?(@interpolation_mode)
+      smoothing_mode_validator = EnumAttributeValidator.new('String', %w["Default", "HighSpeed", "HighQuality", "None", "AntiAlias", "Invalid"])
+      return false unless smoothing_mode_validator.valid?(@smoothing_mode)
+      text_rendering_hint_validator = EnumAttributeValidator.new('String', %w["SystemDefault", "SingleBitPerPixelGridFit", "SingleBitPerPixel", "AntiAliasGridFit", "AntiAlias", "ClearTypeGridFit"])
+      return false unless text_rendering_hint_validator.valid?(@text_rendering_hint)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] compositing_mode Object to be assigned
+    def compositing_mode=(compositing_mode)
+      validator = EnumAttributeValidator.new('String', %w["SourceOver", "SourceCopy"])
+      if compositing_mode.to_i == 0
+        unless validator.valid?(compositing_mode)
+          raise ArgumentError, "invalid value for 'compositing_mode', must be one of #{validator.allowable_values}."
+        end
+        @compositing_mode = compositing_mode
+      else
+        @compositing_mode = validator.allowable_values[compositing_mode.to_i]
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] compositing_quality Object to be assigned
+    def compositing_quality=(compositing_quality)
+      validator = EnumAttributeValidator.new('String', %w["Default", "HighSpeed", "HighQuality", "GammaCorrected", "AssumeLinear", "Invalid"])
+      if compositing_quality.to_i == 0
+        unless validator.valid?(compositing_quality)
+          raise ArgumentError, "invalid value for 'compositing_quality', must be one of #{validator.allowable_values}."
+        end
+        @compositing_quality = compositing_quality
+      else
+        @compositing_quality = validator.allowable_values[compositing_quality.to_i]
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] interpolation_mode Object to be assigned
+    def interpolation_mode=(interpolation_mode)
+      validator = EnumAttributeValidator.new('String', %w["Default", "Low", "High", "Bilinear", "Bicubic", "NearestNeighbor", "HighQualityBilinear", "HighQualityBicubic", "Invalid"])
+      if interpolation_mode.to_i == 0
+        unless validator.valid?(interpolation_mode)
+          raise ArgumentError, "invalid value for 'interpolation_mode', must be one of #{validator.allowable_values}."
+        end
+        @interpolation_mode = interpolation_mode
+      else
+        @interpolation_mode = validator.allowable_values[interpolation_mode.to_i]
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] smoothing_mode Object to be assigned
+    def smoothing_mode=(smoothing_mode)
+      validator = EnumAttributeValidator.new('String', %w["Default", "HighSpeed", "HighQuality", "None", "AntiAlias", "Invalid"])
+      if smoothing_mode.to_i == 0
+        unless validator.valid?(smoothing_mode)
+          raise ArgumentError, "invalid value for 'smoothing_mode', must be one of #{validator.allowable_values}."
+        end
+        @smoothing_mode = smoothing_mode
+      else
+        @smoothing_mode = validator.allowable_values[smoothing_mode.to_i]
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] text_rendering_hint Object to be assigned
+    def text_rendering_hint=(text_rendering_hint)
+      validator = EnumAttributeValidator.new('String', %w["SystemDefault", "SingleBitPerPixelGridFit", "SingleBitPerPixel", "AntiAliasGridFit", "AntiAlias", "ClearTypeGridFit"])
+      if text_rendering_hint.to_i == 0
+        unless validator.valid?(text_rendering_hint)
+          raise ArgumentError, "invalid value for 'text_rendering_hint', must be one of #{validator.allowable_values}."
+        end
+        @text_rendering_hint = text_rendering_hint
+      else
+        @text_rendering_hint = validator.allowable_values[text_rendering_hint.to_i]
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(other)
+      return true if self.equal?(other)
+      self.class == other.class &&
+          compositing_mode == other.compositing_mode &&
+          compositing_quality == other.compositing_quality &&
+          interpolation_mode == other.interpolation_mode &&
+          smoothing_mode == other.smoothing_mode &&
+          string_format == other.string_format &&
+          text_rendering_hint == other.text_rendering_hint
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [compositing_mode, compositing_quality, interpolation_mode, smoothing_mode, string_format, text_rendering_hint].hash
+    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.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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
+        Time.at(/\d/.match(value)[0].to_f).to_datetime
+      when :Date
+        Time.at(/\d/.match(value)[0].to_f).to_date
+      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
+        temp_model = WordsRubySdk.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/words_ruby_sdk/models/header_footer.rb

@@ -0,0 +1,274 @@
+
+require 'date'
+
+module WordsRubySdk
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose" file="HeaderFooter.rb">
+ #   Copyright (c) 2017 Aspose.Words for Cloud
+ # </copyright>
+ # <summary>
+ #   Permission is hereby granted, free of charge, to any person obtaining a copy
+ #  of this software and associated documentation files (the "Software"), to deal
+ #  in the Software without restriction, including without limitation the rights
+ #  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #  copies of the Software, and to permit persons to whom the Software is
+ #  furnished to do so, subject to the following conditions:
+ #
+ #  The above copyright notice and this permission notice shall be included in all
+ #  copies or substantial portions of the Software.
+ #
+ #  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ #  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #  SOFTWARE.
+ # </summary>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+  # Section element
+  class HeaderFooter
+    # Link to the document.
+    attr_accessor :link
+
+    # Paragraph's text
+    attr_accessor :type
+
+    # Link to DrawingObjects resource
+    attr_accessor :drawing_objects
+
+    # Link to Paragraphs resource
+    attr_accessor :paragraphs
+
+    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
+      {
+        :'link' => :'link',
+        :'type' => :'Type',
+        :'drawing_objects' => :'DrawingObjects',
+        :'paragraphs' => :'Paragraphs'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'link' => :'WordsApiLink',
+        :'type' => :'String',
+        :'drawing_objects' => :'LinkElement',
+        :'paragraphs' => :'LinkElement'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.key?(:'link')
+        self.link = attributes[:'link']
+      end
+
+      if attributes.key?(:'Type')
+        self.type = attributes[:'Type']
+      end
+
+      if attributes.key?(:'DrawingObjects')
+        self.drawing_objects = attributes[:'DrawingObjects']
+      end
+
+      if attributes.key?(:'Paragraphs')
+        self.paragraphs = attributes[:'Paragraphs']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = []
+      return 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?
+      type_validator = EnumAttributeValidator.new('String', %w["HeaderEven", "HeaderPrimary", "FooterEven", "FooterPrimary", "HeaderFirst", "FooterFirst"])
+      return false unless type_validator.valid?(@type)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', %w["HeaderEven", "HeaderPrimary", "FooterEven", "FooterPrimary", "HeaderFirst", "FooterFirst"])
+      if type.to_i == 0
+        unless validator.valid?(type)
+          raise ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
+        end
+        @type = type
+      else
+        @type = validator.allowable_values[type.to_i]
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(other)
+      return true if self.equal?(other)
+      self.class == other.class &&
+          link == other.link &&
+          type == other.type &&
+          drawing_objects == other.drawing_objects &&
+          paragraphs == other.paragraphs
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [link, type, drawing_objects, paragraphs].hash
+    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.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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
+        Time.at(/\d/.match(value)[0].to_f).to_datetime
+      when :Date
+        Time.at(/\d/.match(value)[0].to_f).to_date
+      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
+        temp_model = WordsRubySdk.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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