groupdocs_annotation_cloud 19.5 → 22.2

data/lib/groupdocs_annotation_cloud/models/annotation_info.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="annotation_info.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -32,16 +32,22 @@ module GroupDocsAnnotationCloud
   class AnnotationInfo
 
     # Gets or sets the unique identifier
-    attr_accessor :guid
-
-    # Gets or sets the document unique identifier
-    attr_accessor :document_guid
+    attr_accessor :id
 
     # Gets or sets the annotation text
     attr_accessor :text
 
+    # GGets or sets text to be replaced
+    attr_accessor :text_to_replace
+
+    # Gets or sets text horizontal alignment
+    attr_accessor :horizontal_alignment
+
+    # Gets or sets text vertical alignment
+    attr_accessor :vertical_alignment
+
     # Gets or sets the creator unique identifier
-    attr_accessor :creator_guid
+    attr_accessor :creator_id
 
     # Gets or sets the name of the creator
     attr_accessor :creator_name
@@ -52,6 +58,9 @@ module GroupDocsAnnotationCloud
     # Gets or sets the box where annotation will be placed
     attr_accessor :box
 
+    # Gets or sets collection of points that describe rectangles with text
+    attr_accessor :points
+
     # Gets or sets the number of page where annotation will be placed
     attr_accessor :page_number
 
@@ -64,9 +73,6 @@ module GroupDocsAnnotationCloud
     # Gets or sets the annotation type
     attr_accessor :type
 
-    # Gets or sets the annotation access
-    attr_accessor :access
-
     # Gets or sets the array of annotation replies
     attr_accessor :replies
 
@@ -88,8 +94,8 @@ module GroupDocsAnnotationCloud
     # Gets or sets the annotation's background color 
     attr_accessor :background_color
 
-    # Gets or sets the annotation's field text
-    attr_accessor :field_text
+    # Gets or sets annotation color
+    attr_accessor :squiggly_color
 
     # Gets or sets the annotation's font family
     attr_accessor :font_family
@@ -102,6 +108,18 @@ module GroupDocsAnnotationCloud
 
     # Gets or sets the watermark annotation's rotation angle
     attr_accessor :angle
+
+    # Gets or sets z-index. Default value is 0 The z-index property specifies the stack order of an element.
+    attr_accessor :z_index
+
+    # Gets or sets annotation link url
+    attr_accessor :url
+
+    # Gets or sets image file path in cloud storage, for Image annotations
+    attr_accessor :image_path
+
+    # Sets auto scale for watermark annotation
+    attr_accessor :auto_scale
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -127,18 +145,20 @@ module GroupDocsAnnotationCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'guid' => :'Guid',
-        :'document_guid' => :'DocumentGuid',
+        :'id' => :'Id',
         :'text' => :'Text',
-        :'creator_guid' => :'CreatorGuid',
+        :'text_to_replace' => :'TextToReplace',
+        :'horizontal_alignment' => :'HorizontalAlignment',
+        :'vertical_alignment' => :'VerticalAlignment',
+        :'creator_id' => :'CreatorId',
         :'creator_name' => :'CreatorName',
         :'creator_email' => :'CreatorEmail',
         :'box' => :'Box',
+        :'points' => :'Points',
         :'page_number' => :'PageNumber',
         :'annotation_position' => :'AnnotationPosition',
         :'svg_path' => :'SvgPath',
         :'type' => :'Type',
-        :'access' => :'Access',
         :'replies' => :'Replies',
         :'created_on' => :'CreatedOn',
         :'font_color' => :'FontColor',
@@ -146,41 +166,51 @@ module GroupDocsAnnotationCloud
         :'pen_width' => :'PenWidth',
         :'pen_style' => :'PenStyle',
         :'background_color' => :'BackgroundColor',
-        :'field_text' => :'FieldText',
+        :'squiggly_color' => :'SquigglyColor',
         :'font_family' => :'FontFamily',
         :'font_size' => :'FontSize',
         :'opacity' => :'Opacity',
-        :'angle' => :'Angle'
+        :'angle' => :'Angle',
+        :'z_index' => :'ZIndex',
+        :'url' => :'Url',
+        :'image_path' => :'ImagePath',
+        :'auto_scale' => :'AutoScale'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'guid' => :'String',
-        :'document_guid' => :'Integer',
+        :'id' => :'Integer',
         :'text' => :'String',
-        :'creator_guid' => :'String',
+        :'text_to_replace' => :'String',
+        :'horizontal_alignment' => :'String',
+        :'vertical_alignment' => :'String',
+        :'creator_id' => :'Integer',
         :'creator_name' => :'String',
         :'creator_email' => :'String',
         :'box' => :'Rectangle',
+        :'points' => :'Array<Point>',
         :'page_number' => :'Integer',
         :'annotation_position' => :'Point',
         :'svg_path' => :'String',
         :'type' => :'String',
-        :'access' => :'String',
         :'replies' => :'Array<AnnotationReplyInfo>',
         :'created_on' => :'DateTime',
         :'font_color' => :'Integer',
         :'pen_color' => :'Integer',
         :'pen_width' => :'Integer',
-        :'pen_style' => :'Integer',
+        :'pen_style' => :'String',
         :'background_color' => :'Integer',
-        :'field_text' => :'String',
+        :'squiggly_color' => :'Integer',
         :'font_family' => :'String',
         :'font_size' => :'Float',
         :'opacity' => :'Float',
-        :'angle' => :'Float'
+        :'angle' => :'Float',
+        :'z_index' => :'Integer',
+        :'url' => :'String',
+        :'image_path' => :'String',
+        :'auto_scale' => :'BOOLEAN'
       }
     end
 
@@ -192,20 +222,28 @@ module GroupDocsAnnotationCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'Guid')
-        self.guid = attributes[:'Guid']
-      end
-
-      if attributes.key?(:'DocumentGuid')
-        self.document_guid = attributes[:'DocumentGuid']
+      if attributes.key?(:'Id')
+        self.id = attributes[:'Id']
       end
 
       if attributes.key?(:'Text')
         self.text = attributes[:'Text']
       end
 
-      if attributes.key?(:'CreatorGuid')
-        self.creator_guid = attributes[:'CreatorGuid']
+      if attributes.key?(:'TextToReplace')
+        self.text_to_replace = attributes[:'TextToReplace']
+      end
+
+      if attributes.key?(:'HorizontalAlignment')
+        self.horizontal_alignment = attributes[:'HorizontalAlignment']
+      end
+
+      if attributes.key?(:'VerticalAlignment')
+        self.vertical_alignment = attributes[:'VerticalAlignment']
+      end
+
+      if attributes.key?(:'CreatorId')
+        self.creator_id = attributes[:'CreatorId']
       end
 
       if attributes.key?(:'CreatorName')
@@ -220,6 +258,12 @@ module GroupDocsAnnotationCloud
         self.box = attributes[:'Box']
       end
 
+      if attributes.key?(:'Points')
+        if (value = attributes[:'Points']).is_a?(Array)
+          self.points = value
+        end
+      end
+
       if attributes.key?(:'PageNumber')
         self.page_number = attributes[:'PageNumber']
       end
@@ -236,10 +280,6 @@ module GroupDocsAnnotationCloud
         self.type = attributes[:'Type']
       end
 
-      if attributes.key?(:'Access')
-        self.access = attributes[:'Access']
-      end
-
       if attributes.key?(:'Replies')
         if (value = attributes[:'Replies']).is_a?(Array)
           self.replies = value
@@ -270,8 +310,8 @@ module GroupDocsAnnotationCloud
         self.background_color = attributes[:'BackgroundColor']
       end
 
-      if attributes.key?(:'FieldText')
-        self.field_text = attributes[:'FieldText']
+      if attributes.key?(:'SquigglyColor')
+        self.squiggly_color = attributes[:'SquigglyColor']
       end
 
       if attributes.key?(:'FontFamily')
@@ -290,14 +330,42 @@ module GroupDocsAnnotationCloud
         self.angle = attributes[:'Angle']
       end
 
+      if attributes.key?(:'ZIndex')
+        self.z_index = attributes[:'ZIndex']
+      end
+
+      if attributes.key?(:'Url')
+        self.url = attributes[:'Url']
+      end
+
+      if attributes.key?(:'ImagePath')
+        self.image_path = attributes[:'ImagePath']
+      end
+
+      if attributes.key?(:'AutoScale')
+        self.auto_scale = attributes[:'AutoScale']
+      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 = []
-      if @document_guid.nil?
-        invalid_properties.push("invalid value for 'document_guid', document_guid cannot be nil.")
+      if @id.nil?
+        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+      end
+
+      if @horizontal_alignment.nil?
+        invalid_properties.push("invalid value for 'horizontal_alignment', horizontal_alignment cannot be nil.")
+      end
+
+      if @vertical_alignment.nil?
+        invalid_properties.push("invalid value for 'vertical_alignment', vertical_alignment cannot be nil.")
+      end
+
+      if @creator_id.nil?
+        invalid_properties.push("invalid value for 'creator_id', creator_id cannot be nil.")
       end
 
       if @box.nil?
@@ -312,30 +380,78 @@ module GroupDocsAnnotationCloud
         invalid_properties.push("invalid value for 'created_on', created_on cannot be nil.")
       end
 
+      if @z_index.nil?
+        invalid_properties.push("invalid value for 'z_index', z_index cannot be nil.")
+      end
+
+      if @auto_scale.nil?
+        invalid_properties.push("invalid value for 'auto_scale', auto_scale cannot be nil.")
+      end
+
       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?
-      return false if @document_guid.nil?
+      return false if @id.nil?
+      return false if @horizontal_alignment.nil?
+      horizontal_alignment_validator = EnumAttributeValidator.new('String', ["None", "Left", "Center", "Right"])
+      return false unless horizontal_alignment_validator.valid?(@horizontal_alignment)
+      return false if @vertical_alignment.nil?
+      vertical_alignment_validator = EnumAttributeValidator.new('String', ["None", "Top", "Center", "Bottom"])
+      return false unless vertical_alignment_validator.valid?(@vertical_alignment)
+      return false if @creator_id.nil?
       return false if @box.nil?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["Text", "Area", "Point", "TextStrikeout", "Polyline", "TextField", "Watermark", "TextReplacement", "Arrow", "TextRedaction", "ResourcesRedaction", "TextUnderline", "Distance", "Ellipse"])
+      type_validator = EnumAttributeValidator.new('String', ["None", "Area", "Arrow", "Distance", "Ellipse", "Link", "Point", "Polyline", "ResourcesRedaction", "TextField", "TextHighlight", "TextRedaction", "TextReplacement", "TextStrikeout", "TextUnderline", "Watermark", "Image", "TextSquiggly"])
       return false unless type_validator.valid?(@type)
-      access_validator = EnumAttributeValidator.new('String', ["Public", "Private"])
-      return false unless access_validator.valid?(@access)
       return false if @created_on.nil?
+      pen_style_validator = EnumAttributeValidator.new('String', ["Solid", "Dash", "DashDot", "Dot", "LongDash", "DashDotDot"])
+      return false unless pen_style_validator.valid?(@pen_style)
+      return false if @z_index.nil?
+      return false if @auto_scale.nil?
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] horizontal_alignment Object to be assigned
+    def horizontal_alignment=(horizontal_alignment)
+      validator = EnumAttributeValidator.new('String', ["None", "Left", "Center", "Right"])
+      if horizontal_alignment.to_i == 0
+        unless validator.valid?(horizontal_alignment)
+          # raise ArgumentError, "invalid value for 'horizontal_alignment', must be one of #{validator.allowable_values}."
+           @horizontal_alignment = validator.allowable_values[horizontal_alignment.to_i]
+        end
+        @horizontal_alignment = horizontal_alignment
+      else
+        @horizontal_alignment = validator.allowable_values[horizontal_alignment.to_i]
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] vertical_alignment Object to be assigned
+    def vertical_alignment=(vertical_alignment)
+      validator = EnumAttributeValidator.new('String', ["None", "Top", "Center", "Bottom"])
+      if vertical_alignment.to_i == 0
+        unless validator.valid?(vertical_alignment)
+          # raise ArgumentError, "invalid value for 'vertical_alignment', must be one of #{validator.allowable_values}."
+           @vertical_alignment = validator.allowable_values[vertical_alignment.to_i]
+        end
+        @vertical_alignment = vertical_alignment
+      else
+        @vertical_alignment = validator.allowable_values[vertical_alignment.to_i]
+      end
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["Text", "Area", "Point", "TextStrikeout", "Polyline", "TextField", "Watermark", "TextReplacement", "Arrow", "TextRedaction", "ResourcesRedaction", "TextUnderline", "Distance", "Ellipse"])
+      validator = EnumAttributeValidator.new('String', ["None", "Area", "Arrow", "Distance", "Ellipse", "Link", "Point", "Polyline", "ResourcesRedaction", "TextField", "TextHighlight", "TextRedaction", "TextReplacement", "TextStrikeout", "TextUnderline", "Watermark", "Image", "TextSquiggly"])
       if type.to_i == 0
         unless validator.valid?(type)
-          raise ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
+          # raise ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
+           @type = validator.allowable_values[type.to_i]
         end
         @type = type
       else
@@ -344,16 +460,17 @@ module GroupDocsAnnotationCloud
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] access Object to be assigned
-    def access=(access)
-      validator = EnumAttributeValidator.new('String', ["Public", "Private"])
-      if access.to_i == 0
-        unless validator.valid?(access)
-          raise ArgumentError, "invalid value for 'access', must be one of #{validator.allowable_values}."
+    # @param [Object] pen_style Object to be assigned
+    def pen_style=(pen_style)
+      validator = EnumAttributeValidator.new('String', ["Solid", "Dash", "DashDot", "Dot", "LongDash", "DashDotDot"])
+      if pen_style.to_i == 0
+        unless validator.valid?(pen_style)
+          # raise ArgumentError, "invalid value for 'pen_style', must be one of #{validator.allowable_values}."
+           @pen_style = validator.allowable_values[pen_style.to_i]
         end
-        @access = access
+        @pen_style = pen_style
       else
-        @access = validator.allowable_values[access.to_i]
+        @pen_style = validator.allowable_values[pen_style.to_i]
       end
     end
 
@@ -362,18 +479,20 @@ module GroupDocsAnnotationCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          guid == other.guid &&
-          document_guid == other.document_guid &&
+          id == other.id &&
           text == other.text &&
-          creator_guid == other.creator_guid &&
+          text_to_replace == other.text_to_replace &&
+          horizontal_alignment == other.horizontal_alignment &&
+          vertical_alignment == other.vertical_alignment &&
+          creator_id == other.creator_id &&
           creator_name == other.creator_name &&
           creator_email == other.creator_email &&
           box == other.box &&
+          points == other.points &&
           page_number == other.page_number &&
           annotation_position == other.annotation_position &&
           svg_path == other.svg_path &&
           type == other.type &&
-          access == other.access &&
           replies == other.replies &&
           created_on == other.created_on &&
           font_color == other.font_color &&
@@ -381,11 +500,15 @@ module GroupDocsAnnotationCloud
           pen_width == other.pen_width &&
           pen_style == other.pen_style &&
           background_color == other.background_color &&
-          field_text == other.field_text &&
+          squiggly_color == other.squiggly_color &&
           font_family == other.font_family &&
           font_size == other.font_size &&
           opacity == other.opacity &&
-          angle == other.angle
+          angle == other.angle &&
+          z_index == other.z_index &&
+          url == other.url &&
+          image_path == other.image_path &&
+          auto_scale == other.auto_scale
     end
 
     # @see the `==` method
@@ -397,7 +520,7 @@ module GroupDocsAnnotationCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [guid, document_guid, text, creator_guid, creator_name, creator_email, box, page_number, annotation_position, svg_path, type, access, replies, created_on, font_color, pen_color, pen_width, pen_style, background_color, field_text, font_family, font_size, opacity, angle].hash
+      [id, text, text_to_replace, horizontal_alignment, vertical_alignment, creator_id, creator_name, creator_email, box, points, page_number, annotation_position, svg_path, type, replies, created_on, font_color, pen_color, pen_width, pen_style, background_color, squiggly_color, font_family, font_size, opacity, angle, z_index, url, image_path, auto_scale].hash
     end
 
     # Downcases first letter.

data/lib/groupdocs_annotation_cloud/models/annotation_reply_info.rb

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
  # <copyright company="Aspose Pty Ltd" file="annotation_reply_info.rb">
- #   Copyright (c) 2003-2019 Aspose Pty Ltd
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -32,10 +32,10 @@ module GroupDocsAnnotationCloud
   class AnnotationReplyInfo
 
     # Gets or sets the unique identifier
-    attr_accessor :guid
+    attr_accessor :id
 
     # Gets or sets the user's unique identifier
-    attr_accessor :user_guid
+    attr_accessor :user_id
 
     # Gets or sets the user's name
     attr_accessor :user_name
@@ -44,37 +44,37 @@ module GroupDocsAnnotationCloud
     attr_accessor :user_email
 
     # Gets or sets the message
-    attr_accessor :message
+    attr_accessor :comment
 
     # Gets or sets the reply time
     attr_accessor :replied_on
 
     # Gets or sets the parent reply unique identifier
-    attr_accessor :parent_reply_guid
+    attr_accessor :parent_reply_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'guid' => :'Guid',
-        :'user_guid' => :'UserGuid',
+        :'id' => :'Id',
+        :'user_id' => :'UserId',
         :'user_name' => :'UserName',
         :'user_email' => :'UserEmail',
-        :'message' => :'Message',
+        :'comment' => :'Comment',
         :'replied_on' => :'RepliedOn',
-        :'parent_reply_guid' => :'ParentReplyGuid'
+        :'parent_reply_id' => :'ParentReplyId'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'guid' => :'String',
-        :'user_guid' => :'String',
+        :'id' => :'Integer',
+        :'user_id' => :'Integer',
         :'user_name' => :'String',
         :'user_email' => :'String',
-        :'message' => :'String',
+        :'comment' => :'String',
         :'replied_on' => :'DateTime',
-        :'parent_reply_guid' => :'String'
+        :'parent_reply_id' => :'Integer'
       }
     end
 
@@ -86,12 +86,12 @@ module GroupDocsAnnotationCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'Guid')
-        self.guid = attributes[:'Guid']
+      if attributes.key?(:'Id')
+        self.id = attributes[:'Id']
       end
 
-      if attributes.key?(:'UserGuid')
-        self.user_guid = attributes[:'UserGuid']
+      if attributes.key?(:'UserId')
+        self.user_id = attributes[:'UserId']
       end
 
       if attributes.key?(:'UserName')
@@ -102,16 +102,16 @@ module GroupDocsAnnotationCloud
         self.user_email = attributes[:'UserEmail']
       end
 
-      if attributes.key?(:'Message')
-        self.message = attributes[:'Message']
+      if attributes.key?(:'Comment')
+        self.comment = attributes[:'Comment']
       end
 
       if attributes.key?(:'RepliedOn')
         self.replied_on = attributes[:'RepliedOn']
       end
 
-      if attributes.key?(:'ParentReplyGuid')
-        self.parent_reply_guid = attributes[:'ParentReplyGuid']
+      if attributes.key?(:'ParentReplyId')
+        self.parent_reply_id = attributes[:'ParentReplyId']
       end
 
     end
@@ -120,17 +120,32 @@ module GroupDocsAnnotationCloud
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = []
+      if @id.nil?
+        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+      end
+
+      if @user_id.nil?
+        invalid_properties.push("invalid value for 'user_id', user_id cannot be nil.")
+      end
+
       if @replied_on.nil?
         invalid_properties.push("invalid value for 'replied_on', replied_on cannot be nil.")
       end
 
+      if @parent_reply_id.nil?
+        invalid_properties.push("invalid value for 'parent_reply_id', parent_reply_id cannot be nil.")
+      end
+
       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?
+      return false if @id.nil?
+      return false if @user_id.nil?
       return false if @replied_on.nil?
+      return false if @parent_reply_id.nil?
       return true
     end
 
@@ -139,13 +154,13 @@ module GroupDocsAnnotationCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          guid == other.guid &&
-          user_guid == other.user_guid &&
+          id == other.id &&
+          user_id == other.user_id &&
           user_name == other.user_name &&
           user_email == other.user_email &&
-          message == other.message &&
+          comment == other.comment &&
           replied_on == other.replied_on &&
-          parent_reply_guid == other.parent_reply_guid
+          parent_reply_id == other.parent_reply_id
     end
 
     # @see the `==` method
@@ -157,7 +172,7 @@ module GroupDocsAnnotationCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [guid, user_guid, user_name, user_email, message, replied_on, parent_reply_guid].hash
+      [id, user_id, user_name, user_email, comment, replied_on, parent_reply_id].hash
     end
 
     # Downcases first letter.