groupdocs 1.6.0 → 1.7.0

data/lib/groupdocs/questionnaire/question.rb

@@ -33,6 +33,15 @@ module GroupDocs
     # @attr [Array<GroupDocs::Questionnaire::Question::Conditions>] conditions
     attr_accessor :conditions
 
+    # added in release 1.7.0
+    #
+    # @attr [String] regionName
+    attr_accessor :regionName
+    ## @attr [String] hint
+    attr_accessor :hint
+    # @attr [Array<String>] dimension
+    attr_accessor :dimension
+
 
     # Human-readable accessors
     alias_accessor :default_answer, :def_answer

data/lib/groupdocs/questionnaire/style/base_font.rb

@@ -0,0 +1,17 @@
+# added in release 1.7.0
+module GroupDocs
+  class Questionnaire::QuestionnaireCollectorStyle::BaseFont < Api::Entity
+
+    # @attr [String] fontFamily
+    attr_accessor :fontFamily
+    # @attr [Int] fontSize
+    attr_accessor :fontSize
+    # @attr [String] color
+    attr_accessor :color
+    # @attr [Boolean] isBold
+    attr_accessor :isBold
+    # @attr [Boolean] isBold
+    attr_accessor :isItalic
+
+  end # Questionnaire::QuestionnaireCollectorStyle::BaseFont
+end # GroupDocs

data/lib/groupdocs/questionnaire/style/question_title.rb

@@ -0,0 +1,17 @@
+# added in release 1.7.0
+module GroupDocs
+  class Questionnaire::QuestionnaireCollectorStyle::QuestionTitle < Api::Entity
+
+    # @attr [String] fontFamily
+    attr_accessor :fontFamily
+    # @attr [Int] fontSize
+    attr_accessor :fontSize
+    # @attr [String] color
+    attr_accessor :color
+    # @attr [Boolean] isBold
+    attr_accessor :isBold
+    # @attr [Boolean] isBold
+    attr_accessor :isItalic
+
+  end # Questionnaire::QuestionnaireCollectorStyle::QuestionTitle
+end # GroupDocs

data/lib/groupdocs/questionnaire/style/title.rb

@@ -0,0 +1,17 @@
+# added in release 1.7.0
+module GroupDocs
+  class Questionnaire::QuestionnaireCollectorStyle::Title < Api::Entity
+
+    # @attr [String] fontFamily
+    attr_accessor :fontFamily
+    # @attr [Int] fontSize
+    attr_accessor :fontSize
+    # @attr [String] color
+    attr_accessor :color
+    # @attr [Boolean] isBold
+    attr_accessor :isBold
+    # @attr [Boolean] isBold
+    attr_accessor :isItalic
+
+  end # Questionnaire::QuestionnaireCollectorStyle::Title
+end # GroupDocs

data/lib/groupdocs/signature/envelope.rb

@@ -23,17 +23,21 @@ module GroupDocs
     include Signature::RecipientMethods
     extend  Signature::ResourceMethods
 
+    #
+    # Changed in release 1.7.0
+    #
     #
     # Returns a list of all envelopes.
     #
     # @param [Hash] options Hash of options
     # @option options [Integer] :page Page to start with
     # @option options [Integer] :records How many items to list
-    # @option options [Integer] :status_id Filter by status identifier
-    # @option options [String] :document Filter by document GUID
-    # @option options [String] :recipient Filter by recipient email
-    # @option options [String] :date Filter by date
-    # @option options [String] :name Filter by name
+    # @option options [Integer] :status_id Filter envelopes by status identifier
+    # @option options [String] :document Filter envelopes by document GUID
+    # @option options [String] :recipient Filter envelopes by recipient email
+    # @option options [String] :date Filter envelopes by date
+    # @option options [String] :name Filter envelopes by name
+    # @option options [String] :tag Filter envelopes by tag
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
@@ -92,8 +96,33 @@ module GroupDocs
     attr_accessor :envelopeExpireTime
     # @attr [Boolean] isDemo
     attr_accessor :isDemo
-    # @attr [Symbol] status
-    attr_accessor :status
+
+    # added in release 1.7.0
+    # @attr [String] updatedDateTime
+    attr_accessor :updatedDateTime
+    # @attr [Boolean] attachSignedDocument
+    attr_accessor :attachSignedDocument
+    # @attr [Boolean] includeViewLink
+    attr_accessor :includeViewLink
+    # @attr [Boolean] canBeCommented
+    attr_accessor :canBeCommented
+    # @attr [Boolean] inPersonSign
+    attr_accessor :inPersonSign
+    # @attr [String] ownerName
+    attr_accessor :ownerName
+    # @attr [Boolean] enableTypedSignature
+    attr_accessor :enableTypedSignature
+    # @attr [Boolean] enableUploadedSignature
+    attr_accessor :enableUploadedSignature
+    # @attr [Boolean] requireUserAuthForSign
+    attr_accessor :requireUserAuthForSign
+    # @attr [Boolean] requestUserAuthByPhoto
+    attr_accessor :requestUserAuthByPhoto
+    # @attr [Boolean] showRecipientCommentInSignedDocument
+    attr_accessor :showRecipientCommentInSignedDocument
+    # @attr [String] tags
+    attr_accessor :tags
+
 
     # Human-readable accessors
     alias_accessor :creation_date_time,   :creationDateTime
@@ -290,10 +319,15 @@ module GroupDocs
       Signature::Field.new(json[:field])
     end
 
+    #
+    # Changed in release 1.7.0
     #
     # Signs envelope.
     #
     # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Hash] settings
+    # @option settings [String] :authData (required)
+    # @option settings [String] :comment (required)
     # @param [Hash] options
     # @option options [Boolean] :public Defaults to false
     # @param [Hash] access Access credentials
@@ -301,7 +335,7 @@ module GroupDocs
     # @option access [String] :private_key
     # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
     #
-    def sign!(recipient, options = {}, access = {})
+    def sign!(recipient, settings = {}, options = {}, access = {})
       recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
         "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
 
@@ -310,6 +344,7 @@ module GroupDocs
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/signature/#{client_id}/envelopes/#{id}/recipient/#{recipient.id}/sign"
+        request[:request_body] = settings
       end.execute!
     end
 

data/lib/groupdocs/signature/form.rb

@@ -23,10 +23,11 @@ module GroupDocs
     # @param [Hash] options Hash of options
     # @option options [Integer] :page Page to start with
     # @option options [Integer] :records How many items to list
-    # @option options [Integer] :status_id Filter by status identifier
-    # @option options [String] :document Filter by document GUID
-    # @option options [String] :date Filter by date
-    # @option options [String] :name Filter by name
+    # @option options [Integer] :status_id Filter forms by status identifier
+    # @option options [String] :document Filter forms by document GUID
+    # @option options [String] :date Filter forms by date
+    # @option options [String] :name Filter forms by name
+    # @option options [String] :tag Filter forms by tag
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
@@ -265,7 +266,7 @@ module GroupDocs
     end
 
     #
-    # Changed in release 1.5.8
+    # Changed in release 1.7.0
     #
     # Returns an array of fields for document per participant.
     #
@@ -277,14 +278,12 @@ module GroupDocs
     # @option access [String] :private_key
     # @raise [ArgumentError] if document is not GroupDocs::Document
     #
-    def fields!(document, options = {}, access = {})
-      document.is_a?(GroupDocs::Document) or raise ArgumentError,
-        "Document should be GroupDocs::Document object, received: #{document.inspect}"
+    def fields!(options = {}, access = {})
 
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
-        request[:path] = "/signature/{{client_id}}/forms/#{id}/documents/#{document.file.guid}/fields"
+        request[:path] = "/signature/{{client_id}}/forms/#{id}/fields"
       end
       api.add_params(options)
       json = api.execute!
@@ -294,6 +293,7 @@ module GroupDocs
       end
     end
 
+
     #
     # Adds field for document.
     #
@@ -536,11 +536,14 @@ module GroupDocs
     end
 
     #
-    # Changed in release 1.5.8
+    # Changed in release 1.7.0
     #
     # Public sign form.
     #
-    # @param [String] form Form GUID
+    # @param [Hash] settings
+    # @option settings [String] :authData (required)
+    # @option settings [String] :comment (required)
+    # @param [String] filepath Path to file to be uploaded
     # @param [String] participant Participant GUID
     # @param [String] authentication Authentication signature
     # @param [String] participant_name Participant Name
@@ -549,11 +552,14 @@ module GroupDocs
     # @option access [String] :private_key
     # @return [Array]
     #
-    def sign!( participant, authentication, participant_name, access = {})
+    def sign!( filepath, participant, authentication, participant_name, settings = {}, access = {})
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/signature/public/forms/#{id}/participant/#{participant}/sign"
+        request[:request_body] = Object::File.new(filepath, 'rb')
+        request[:request_body] = settings
+
       end
       api.add_params(:participantAuthSignature => authentication, :name => participant_name)
       api.execute!
@@ -643,5 +649,100 @@ module GroupDocs
       filepath
     end
 
+    #
+    # Added in release 1.7.0
+    #
+    # Update Form Participant.
+    #
+    # @param [String] form Form GUID
+    # @param [String] participant Participant GUID
+    # @param [String] authentication Authentication signature
+    # @param [String] participant_name Participant Name
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def update_partipicant!(participant, email, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/public/forms/#{id}/participant/#{participant}"
+      end
+      api.add_params(:email => email)
+      api.execute!
+    end
+
+    #
+    # Added in release 1.7.0
+    #
+    # Validate Particpiant Identity.
+    #
+    # @param [String] participant Participant GUID
+    # @param [String] code Code to be validated
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def validate_partipicant!(participant, code, access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/public/forms/#{id}/participant/#{participant}/validationCode/#{code}"
+      end.execute!
+    end
+
+    #
+    # Added in release 1.7.0
+    #
+    # Get form fields for document in form per participant.
+    #
+    # @param [GroupDocs::Document] document
+    # @param  [Hash] options
+    # @option options [String] :field Field GUID
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if document is not GroupDocs::Document
+    #
+    def document_fields!(document, options = {}, access = {})
+      document.is_a?(GroupDocs::Document) or raise ArgumentError,
+                                                   "Document should be GroupDocs::Document object, received: #{document.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/{{client_id}}/forms/#{id}/documents/#{document.file.guid}/fields"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:fields].map do |field|
+        Signature::Field.new(field)
+      end
+    end
+
+    #
+    # Changed in release 1.7.0
+    #
+    # Get form audit logs
+    #
+    # @param  [Hash] options
+    # @option options [String] :field Field GUID
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if document is not GroupDocs::Document
+    #
+    def get_logs!(access = {})
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/{{client_id}}/forms/#{id}/logs"
+      end.execute!
+    end
+
   end # Signature::Form
 end # GroupDocs

data/lib/groupdocs/signature/recipient.rb

@@ -27,10 +27,45 @@ module GroupDocs
     # @attr [Symbol] status
     attr_accessor :status
 
+    # added in release 1.7.0
+
+    # @attr [String] userGuid
+    attr_accessor :userGuid
+    # @attr [String] statusMessage
+    attr_accessor :statusMessage
+    # @attr [String] statusDateTime
+    attr_accessor :statusDateTime
+    # @attr [Double] delegatedRecipientId
+    attr_accessor :delegatedRecipientId
+    # @attr [String] signatureFingerprint
+    attr_accessor :signatureFingerprint
+    # @attr [String] signatureHost
+    attr_accessor :signatureHost
+    # @attr [String] signatureLocation
+    attr_accessor :signatureLocation
+    # @attr [String] signatureBrowser
+    attr_accessor :signatureBrowser
+    # @attr [String] embedUrl
+    attr_accessor :embedUrl
+    # @attr [String] comment
+    attr_accessor :comment
+
     # Human-readable accessors
-    alias_accessor :first_name, :firstName
-    alias_accessor :last_name,  :lastName
-    alias_accessor :role_id,    :roleId
+    alias_accessor :first_name,               :firstName
+    alias_accessor :last_name,                :lastName
+    alias_accessor :role_id,                  :roleId
+
+    # added in release 1.7.0
+    alias_accessor :user_guid,                 :userGuid
+    alias_accessor :status_message,            :statusMessage
+    alias_accessor :status_date_time,          :statusDateTime
+    alias_accessor :delegated_recipient_id,    :delegatedRecipientId
+    alias_accessor :signature_fingerprint,     :signatureFingerprint
+    alias_accessor :signature_host,            :signatureHost
+    alias_accessor :signature_location,        :signatureLocation
+    alias_accessor :signature_browser,         :signatureBrowser
+    alias_accessor :embed_url,                 :embedUrl
+
 
     #
     # Converts status to human-readable format.

data/lib/groupdocs/signature/shared/field_methods.rb

@@ -142,11 +142,13 @@ module GroupDocs
       # @raise [ArgumentError] if field is not GroupDocs::Signature::Field
       # @raise [ArgumentError] if document is not GroupDocs::Document
       #
-      def modify_field!(field, document, access = {})
+      def modify_field!(field, document, recipient, access = {})
         field.is_a?(GroupDocs::Signature::Field) or raise ArgumentError,
           "Field should be GroupDocs::Signature::Field object, received: #{field.inspect}"
         document.is_a?(GroupDocs::Document) or raise ArgumentError,
           "Document should be GroupDocs::Document object, received: #{document.inspect}"
+        recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+          "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
 
         # prepare payload
         payload = field.to_hash # field itself
@@ -156,7 +158,7 @@ module GroupDocs
         Api::Request.new do |request|
           request[:access] = access
           request[:method] = :PUT
-          request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/documents/#{document.file.guid}/field/#{field.id}"
+          request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/documents/#{document.file.guid}/recipientGuid/#{recipient.id}field/#{field.id}"
           request[:request_body] = payload
         end.execute!
       end

data/lib/groupdocs/signature/template.rb

@@ -9,11 +9,18 @@ module GroupDocs
     extend  Signature::ResourceMethods
 
     #
-    # Returns a list of all templates.
+    # Changed in release 1.7.0
+    #
+    #
+    # Returns a list of all templates.  
     #
     # @param [Hash] options Hash of options
     # @option options [Integer] :page Page to start with
     # @option options [Integer] :records How many items to list
+    # @option options [String] :documentGuid Fitler templates by document originalMD5
+    # @option options [String] :recipientName Filter templates by recipient nickname
+    # @option options [String] :name Filter templates by signatureTemplate name
+    # @option options [String] :tag Filter templates by tag
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
@@ -36,6 +43,16 @@ module GroupDocs
     # @attr [Integer] templateExpireTime
     attr_accessor :templateExpireTime
 
+    #added in release 1.7.0
+    # @attr [Double] fieldsCount
+    attr_accessor :fieldsCount
+    # @attr [Boolean] enableTypedSignature
+    attr_accessor :enableTypedSignature
+    # @attr [Boolean] enableUploadedSignature
+    attr_accessor :enableUploadedSignature
+    # @attr [String] tags
+    attr_accessor :tags
+
     # Human-readable accessors
     alias_accessor :template_expire_time, :templateExpireTime
 
@@ -101,5 +118,7 @@ module GroupDocs
       api.execute!
     end
 
+
+
   end # Signature::Template
 end # GroupDocs