groupdocs_annotation_cloud 21.6 → 22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a9956e274f0fc599d8b2feb58426edbea1b7b6b
-  data.tar.gz: 3674ecb62ee775c97c5b19f6bffcc19e1545e577
+  metadata.gz: dc6e52b8b18e5b528cc77ff6823e4c702e416f73
+  data.tar.gz: 6a540f8224c9ac312084c31db0a5af521fbb55ec
 SHA512:
-  metadata.gz: d4773c1b711085fa304503e62c7dc427316d0857aaff6aa9ccfa30a769e6e885dbc89dae46ab23e46ee1550d338313e46875053ce7d5b704a8302657f67eb023
-  data.tar.gz: 146ca64356f5b2f2ce01fa659337abb8722270c677fdcb122936d3f748491fd4383db09df2be7be151133b94d9a7f6e54058e1e2fbc14ac28d65f60b1c29af47
+  metadata.gz: 35eb6a54aeb104710a25df26ee6a6677c762d1e30463c61bc9823e6a5d40c1a2cffd499de9c78d68de4d04e1da48a9d1940c72f2592d43ad99aa74d6b07ed624
+  data.tar.gz: 8335287472b08d3410cd53bfa218fd9d3b9dfcd40473fd4f8a39b08528b1060025bfaa211f17aefbd54274fa35b84aba95bf866d6698b16f80ae0f70701bce31

data/lib/groupdocs_annotation_cloud/api/license_api.rb

@@ -0,0 +1,169 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="license.rb">
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
+# </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>
+# -----------------------------------------------------------------------------------
+
+require 'uri'
+require 'date'
+
+module GroupDocsAnnotationCloud
+  #
+  # GroupDocs.Annotation Cloud API
+  #
+  class LicenseApi
+    attr_accessor :config
+
+    #make LicenseApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of LicenseApi
+    #
+    # @param [config] Configuration 
+    # @return [LicenseApi] New instance of LicenseApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      @access_token = nil
+    end
+
+    # Initializes new instance of LicenseApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [LicenseApi] New instance of LicenseApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of LicenseApi
+    #
+    # @param [config] Configuration 
+    # @return [LicenseApi] New instance of LicenseApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Get license consumption
+    # 
+    # @return [ConsumptionResult]
+    def get_consumption_credit()
+      data, _status_code, _headers = get_consumption_credit_with_http_info()
+      data
+    end
+
+    # Get license consumption
+    # 
+    
+    # @return [Array<(ConsumptionResult, Fixnum, Hash)>]
+    # ConsumptionResult data, response status code and response headers
+    def get_consumption_credit_with_http_info()
+      
+
+      @api_client.config.logger.debug 'Calling API: LicenseApi.get_consumption_credit ...' if @api_client.config.debugging
+      # resource path
+      local_var_path = '/annotation/consumption'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        access_token: get_access_token,
+                                                        return_type: 'ConsumptionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        LicenseApi#get_consumption_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    #
+    # Helper method to convert first letter to downcase
+    #
+    private def downcase_first_letter(str)
+      value = str[0].downcase + str[1..-1]
+      value
+    end
+                 
+    #
+    # Retrieves access token
+    #
+    private def get_access_token
+        if @access_token.nil? then
+          request_access_token
+        end
+        
+        @access_token  
+    end
+
+    #
+    # Gets a access token from server
+    #
+    private def request_access_token
+        auth_config = Configuration.new(@config.app_sid, @config.app_key)
+        auth_config.api_base_url = @config.api_base_url
+        auth_config.debugging = @config.debugging
+        auth_config.logger = @config.logger
+        auth_config.temp_folder_path = @config.temp_folder_path
+        auth_config.client_side_validation = @config.client_side_validation
+        auth_config.api_version = ''
+
+        auth_api_client = ApiClient.new(auth_config)
+
+        request_url = "/connect/token"
+        post_data = "grant_type=client_credentials&client_id=#{@config.app_sid}&client_secret=#{@config.app_key}"
+
+        data, _status_code, _header = auth_api_client.call_api(:POST, request_url, :body => post_data, :return_type => 'Object')
+        
+        @access_token = data[:access_token]
+
+        expires_in_seconds = data[:expires_in].to_i - 5 * 60 
+        expires_in_days = Rational(expires_in_seconds, 60 * 60 * 24)
+        @access_token_expires_at = DateTime.now + expires_in_days
+    end
+    
+    # requires all files inside a directory from current dir
+    # @param _dir can be relative path like '/lib' or "../lib"
+    private def require_all(_dir)
+      Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), _dir)) + "/*.rb"].each do |file|
+        require file
+      end
+    end
+  end
+end

data/lib/groupdocs_annotation_cloud/models/annotation_info.rb

@@ -94,6 +94,9 @@ module GroupDocsAnnotationCloud
     # Gets or sets the annotation's background color 
     attr_accessor :background_color
 
+    # Gets or sets annotation color
+    attr_accessor :squiggly_color
+
     # Gets or sets the annotation's font family
     attr_accessor :font_family
 
@@ -114,6 +117,9 @@ module GroupDocsAnnotationCloud
 
     # 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
@@ -160,13 +166,15 @@ module GroupDocsAnnotationCloud
         :'pen_width' => :'PenWidth',
         :'pen_style' => :'PenStyle',
         :'background_color' => :'BackgroundColor',
+        :'squiggly_color' => :'SquigglyColor',
         :'font_family' => :'FontFamily',
         :'font_size' => :'FontSize',
         :'opacity' => :'Opacity',
         :'angle' => :'Angle',
         :'z_index' => :'ZIndex',
         :'url' => :'Url',
-        :'image_path' => :'ImagePath'
+        :'image_path' => :'ImagePath',
+        :'auto_scale' => :'AutoScale'
       }
     end
 
@@ -194,13 +202,15 @@ module GroupDocsAnnotationCloud
         :'pen_width' => :'Integer',
         :'pen_style' => :'String',
         :'background_color' => :'Integer',
+        :'squiggly_color' => :'Integer',
         :'font_family' => :'String',
         :'font_size' => :'Float',
         :'opacity' => :'Float',
         :'angle' => :'Float',
         :'z_index' => :'Integer',
         :'url' => :'String',
-        :'image_path' => :'String'
+        :'image_path' => :'String',
+        :'auto_scale' => :'BOOLEAN'
       }
     end
 
@@ -300,6 +310,10 @@ module GroupDocsAnnotationCloud
         self.background_color = attributes[:'BackgroundColor']
       end
 
+      if attributes.key?(:'SquigglyColor')
+        self.squiggly_color = attributes[:'SquigglyColor']
+      end
+
       if attributes.key?(:'FontFamily')
         self.font_family = attributes[:'FontFamily']
       end
@@ -328,6 +342,10 @@ module GroupDocsAnnotationCloud
         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?
@@ -366,6 +384,10 @@ module GroupDocsAnnotationCloud
         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
 
@@ -382,12 +404,13 @@ module GroupDocsAnnotationCloud
       return false if @creator_id.nil?
       return false if @box.nil?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["None", "Area", "Arrow", "Distance", "Ellipse", "Link", "Point", "Polyline", "ResourcesRedaction", "TextField", "TextHighlight", "TextRedaction", "TextReplacement", "TextStrikeout", "TextUnderline", "Watermark", "Image"])
+      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)
       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
 
@@ -424,7 +447,7 @@ module GroupDocsAnnotationCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["None", "Area", "Arrow", "Distance", "Ellipse", "Link", "Point", "Polyline", "ResourcesRedaction", "TextField", "TextHighlight", "TextRedaction", "TextReplacement", "TextStrikeout", "TextUnderline", "Watermark", "Image"])
+      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}."
@@ -477,13 +500,15 @@ module GroupDocsAnnotationCloud
           pen_width == other.pen_width &&
           pen_style == other.pen_style &&
           background_color == other.background_color &&
+          squiggly_color == other.squiggly_color &&
           font_family == other.font_family &&
           font_size == other.font_size &&
           opacity == other.opacity &&
           angle == other.angle &&
           z_index == other.z_index &&
           url == other.url &&
-          image_path == other.image_path
+          image_path == other.image_path &&
+          auto_scale == other.auto_scale
     end
 
     # @see the `==` method
@@ -495,7 +520,7 @@ module GroupDocsAnnotationCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def 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, font_family, font_size, opacity, angle, z_index, url, image_path].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/consumption_result.rb

@@ -0,0 +1,234 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="consumption_result.rb">
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
+ # </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>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+require 'date'
+
+module GroupDocsAnnotationCloud
+  # Metered license consumption information
+  class ConsumptionResult
+
+    # Amount of used credits
+    attr_accessor :credit
+
+    # Amount of MBs processed
+    attr_accessor :quantity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'credit' => :'Credit',
+        :'quantity' => :'Quantity'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'credit' => :'Float',
+        :'quantity' => :'Float'
+      }
+    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?(:'Credit')
+        self.credit = attributes[:'Credit']
+      end
+
+      if attributes.key?(:'Quantity')
+        self.quantity = attributes[:'Quantity']
+      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 @credit.nil?
+        invalid_properties.push("invalid value for 'credit', credit cannot be nil.")
+      end
+
+      if @quantity.nil?
+        invalid_properties.push("invalid value for 'quantity', quantity 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 @credit.nil?
+      return false if @quantity.nil?
+      return true
+    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 &&
+          credit == other.credit &&
+          quantity == other.quantity
+    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
+      [credit, quantity].hash
+    end
+
+    # Downcases first letter.
+    # @return downcased string
+    def uncap(str)
+      str[0, 1].downcase + str[1..-1]
+    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|
+        pname = uncap(self.class.attribute_map[key]).intern
+        value = attributes[pname]
+        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 value.is_a?(Array)
+            self.send("#{key}=", value.map { |v| _deserialize($1, v) })
+          end
+        elsif !value.nil?
+          self.send("#{key}=", _deserialize(type, value))
+        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
+        Date.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
+        temp_model = GroupDocsAnnotationCloud.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/groupdocs_annotation_cloud/version.rb

@@ -25,5 +25,5 @@
  # --------------------------------------------------------------------------------------------------------------------
  #
 module GroupDocsAnnotationCloud
-  VERSION = "21.6".freeze
+  VERSION = "22.2".freeze
 end

data/lib/groupdocs_annotation_cloud.rb

@@ -33,6 +33,7 @@ require_relative 'groupdocs_annotation_cloud/configuration'
 require_relative 'groupdocs_annotation_cloud/models/annotate_options'
 require_relative 'groupdocs_annotation_cloud/models/annotation_info'
 require_relative 'groupdocs_annotation_cloud/models/annotation_reply_info'
+require_relative 'groupdocs_annotation_cloud/models/consumption_result'
 require_relative 'groupdocs_annotation_cloud/models/disc_usage'
 require_relative 'groupdocs_annotation_cloud/models/document_info'
 require_relative 'groupdocs_annotation_cloud/models/error'
@@ -63,5 +64,6 @@ require_relative 'groupdocs_annotation_cloud/api/annotate_api'
 require_relative 'groupdocs_annotation_cloud/api/file_api'
 require_relative 'groupdocs_annotation_cloud/api/folder_api'
 require_relative 'groupdocs_annotation_cloud/api/info_api'
+require_relative 'groupdocs_annotation_cloud/api/license_api'
 require_relative 'groupdocs_annotation_cloud/api/preview_api'
 require_relative 'groupdocs_annotation_cloud/api/storage_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdocs_annotation_cloud
 version: !ruby/object:Gem::Version
-  version: '21.6'
+  version: '22.2'
 platform: ruby
 authors:
 - GroupDocs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,6 +75,7 @@ files:
 - lib/groupdocs_annotation_cloud/api/file_api.rb
 - lib/groupdocs_annotation_cloud/api/folder_api.rb
 - lib/groupdocs_annotation_cloud/api/info_api.rb
+- lib/groupdocs_annotation_cloud/api/license_api.rb
 - lib/groupdocs_annotation_cloud/api/preview_api.rb
 - lib/groupdocs_annotation_cloud/api/storage_api.rb
 - lib/groupdocs_annotation_cloud/api_client.rb
@@ -84,6 +85,7 @@ files:
 - lib/groupdocs_annotation_cloud/models/annotation_api_link.rb
 - lib/groupdocs_annotation_cloud/models/annotation_info.rb
 - lib/groupdocs_annotation_cloud/models/annotation_reply_info.rb
+- lib/groupdocs_annotation_cloud/models/consumption_result.rb
 - lib/groupdocs_annotation_cloud/models/disc_usage.rb
 - lib/groupdocs_annotation_cloud/models/document_info.rb
 - lib/groupdocs_annotation_cloud/models/error.rb