groupdocs 1.5.7 → 1.5.8

data/lib/groupdocs/document/field.rb

@@ -9,10 +9,14 @@ module GroupDocs
     attr_accessor :type
     # @attr [GroupDocs::Document::Rectangle] rect
     attr_accessor :rect
-    # @attr [String] maxlength
+    # @attr [Int] maxlength
     attr_accessor :maxlength
     # @attr [Boolean] mandatory
     attr_accessor :mandatory
+    # @attr [String] fieldtype
+    attr_accessor :fieldtype
+    # @attr [Array] acceptableValues
+    attr_accessor :acceptableValues
 
     #
     # Coverts passed hash to GroupDocs::Document::Rectangle object.

data/lib/groupdocs/job.rb

@@ -13,6 +13,11 @@ module GroupDocs
       :print              => 128,
       :compare            => 256,
       :import_annotations => 512,
+      # add in release 1.5.8
+      :split => 1024,
+      :view => 2048,
+      :index => 4096,
+      :number_lines => 8192
     }
 
     extend Api::Helpers::ByteFlag
@@ -22,8 +27,13 @@ module GroupDocs
     # Returns array of jobs.
     #
     # @param [Hash] options Hash of options
-    # @option options [Integer] :page Page to start with
-    # @option options [Integer] :count How many items to list
+    # @option options [String] :page Page Index
+    # @option options [String] :date Data
+    # @option options [String] :count How many items to list
+    # @option options [String] :statusIds Comma separated status identifiers
+    # @option options [String] :actions Actions
+    # @option options [String] :excluded_actions Excluded actions
+    # @option options [String] :jobName Foltred job name
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key

data/lib/groupdocs/questionnaire.rb

@@ -87,6 +87,23 @@ module GroupDocs
     # @attr [Array<String>] document_ids
     attr_accessor :document_ids
 
+    # added in release 1.5.8
+    #
+    # @attr [Array<String>] formats
+    attr_accessor :formats
+    # @attr [String] folder
+    attr_accessor :folder
+    # @attr [String] emails
+    attr_accessor :emails
+    # @attr [String] output_format
+    attr_accessor :output_format
+    # @attr [Boolean] open_on_completion
+    attr_accessor :open_on_completion
+    # @atrr [Integer] allowed_operations
+    attr_accessor :allowed_operations
+
+
+
     # Human-readable accessors
     alias_accessor :description, :descr
 
@@ -134,6 +151,19 @@ module GroupDocs
     #
     # Creates questionnaire.
     #
+    #  @example
+    #
+    # questionnaire = GroupDocs::Questionnaire.new()
+    # pages = GroupDocs::Questionnaire::Page.new()
+    # questions = GroupDocs::Questionnaire::Question.new()
+    # answer = GroupDocs::Questionnaire::Question::Answer.new()
+    # questions.answers = [answer]
+    # conditions = GroupDocs::Questionnaire::Question::Conditions.new()
+    # questions.conditions = [conditions]
+    # pages.questions = [questions]
+    # questionnaire.pages = [pages]
+    # questionnaire.create!
+    #
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
@@ -225,7 +255,10 @@ module GroupDocs
       end
     end
 
-   #
+    #
+    # Changed in release 1.5.8
+    #
+    #
     # Returns an array of questionnaire collectors.
     #
     #
@@ -243,7 +276,7 @@ module GroupDocs
         request[:method] = :GET
         request[:path] = "/merge/{{client_id}}/questionnaires/#{guid}/collectors"
       end
-        api = add_params(options)
+        api.add_params(options)
         json = api.execute!
 
       json[:collectors].map do |collector|
@@ -318,7 +351,9 @@ module GroupDocs
       end
     end
 	
-	#
+	  #
+    # Changed in release 1.5.8
+    #
     # Copy file to given path.
     #
     # @param [String] path (required)
@@ -340,11 +375,146 @@ module GroupDocs
         request[:headers] = { :'Groupdocs-Copy' => id }
         request[:path] = "/merge/{{client_id}}/files/#{path}"
       end
-      api = add_params(:mode => mode)
+      api.add_params(:mode => mode)
       json = api.execute!
 
       json[:templates]
     end
 
+
+    #
+    # Added in release 1.5.8
+    #
+    # Get associated document by questionnaire
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def get_document!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{id}/document"
+      end.execute!
+    end
+
+    #
+    # Added in release 1.5.8
+    #
+    # Returns an array of questionnaires by name.
+    #
+    # @param [Hash] options Hash of options
+    # @option options [String] :name Questionnaire name
+    # @option options [Symbol] :status Filter questionnaires by status
+    # @option options [Integer] :page_number Page to start with
+    # @option options [Integer] :page_size How many items to list
+    # @option options [String] :orderBy Order by column (optional)
+    # @option options [Bool] :isAscending Order by ascending or descending (optional)
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Questionnaire>]
+    #
+    def self.get_by_name!(options = {}, access = {})
+      if options[:status]
+        # TODO find better way to parse status
+        options[:status] = new.send(:parse_status, options[:status])
+      end
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/merge/{{client_id}}/questionnaires/filter'
+      end
+
+      api.add_params(options)
+      json = api.execute!
+
+      json[:questionnaires].map do |questionnaire|
+        new(questionnaire)
+      end
+    end
+
+    #
+    # Added in release 1.5.8
+    #
+    # Delete list of questionnaires by GUIDs.
+    #
+    # @param [Hash] access Access credentials
+    # @option guids [Array<String>] List of Questionnaires Guid
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def delete_list!(guids, access = {})
+     api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/merge/{{client_id}}/questionnaires/list"
+        request[:request_body] = guids
+     end
+     
+     api.execute!
+    end
+
+    #
+    # Added in release 1.5.8
+    #
+    # Removes questionnaire collector.
+    #
+    # @param [Hash] access Access credentials
+    # @option collectors [Array<String>] List of Collectors Guid
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def delete_collectors_list!(collectors, access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/list"
+        request[:request_body] = collectors
+      end.execute!
+    end
+
+    #
+    # Added in release 1.5.8
+    #
+    # Removes questionnaire execution.
+    #
+    # @param [Hash] access Access credentials
+    # @option executions [Array<String>] List of Executions Guid
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def delete_executions_list!(executions, access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/merge/{{client_id}}/questionnaires/executions/list"
+        request[:request_body] = executions
+      end.execute!
+    end
+
+    #
+    # Added in release 1.5.8
+    #
+    # Delete list of datasource fields.
+    #
+    # @param [Hash] access Access credentials
+    # @option datasource [Array<String>] List of Datasources Guid
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def delete_datasources_list!(datasources, access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/merge/{{client_id}}datasources/list"
+        request[:request_body] = datasources
+      end.execute!
+    end
+
+
+
   end # Questionnaire
 end # GroupDocs

data/lib/groupdocs/questionnaire/collector.rb

@@ -258,5 +258,26 @@ module GroupDocs
       Job.new(:id => json[:job_id])
     end
 
+
+    #
+    # Added in release 1.5.8
+    #
+    # Get questionnaire by collector guid
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def get_questionnaire!(access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/collector/#{guid}"
+      end
+      json = api.execute!
+      Questionnaire.new(json[:questionnaire])
+
+    end
+
   end # Questionnaire::Collector
 end # GroupDocs

data/lib/groupdocs/questionnaire/question.rb

@@ -2,6 +2,7 @@ module GroupDocs
   class Questionnaire::Question < Api::Entity
 
     require 'groupdocs/questionnaire/question/answer'
+    require 'groupdocs/questionnaire/question/conditions'
 
     TYPES = %w(GenericText MultipleChoice)
 
@@ -18,9 +19,27 @@ module GroupDocs
     # @attr [Array<Hash>] answers
     attr_accessor :answers
 
+    #
+    # added in release 1.5.8
+    #
+    # @attr [Boolean] disabled
+    attr_accessor :disabled
+    # @attr [Integer] max_length
+    attr_accessor :max_length
+    # @attr [GroupDocs::Document::Rectangle] rect
+    attr_accessor :rect
+    # @attr [Array<String>] acceptableValues
+    attr_accessor :acceptableValues
+    # @attr [Array<GroupDocs::Questionnaire::Question::Conditions>] conditions
+    attr_accessor :conditions
+
+
     # Human-readable accessors
     alias_accessor :default_answer, :def_answer
 
+    # added in release 1.5.8
+    alias_accessor :acceptable_values, :acceptableValues
+
     #
     # Converts each answer to GroupDocs::Questionnaire::Question::Answer object.
     #

data/lib/groupdocs/questionnaire/question/answer.rb

@@ -6,5 +6,10 @@ module GroupDocs
     # @attr [String] value
     attr_accessor :value
 
+    # added in release 1.5.8
+    # @attr [Integer] ordinal
+    attr_accessor :ordinal
+
+
   end # Questionnaire::Question::Answer
 end # GroupDocs

data/lib/groupdocs/questionnaire/question/conditions.rb

@@ -0,0 +1,20 @@
+# added in release 1.5.8
+
+module GroupDocs
+  class Questionnaire::Question::Conditions < Api::Entity
+
+    # @attr [String] fieldId
+    attr_accessor :fieldId
+    # @attr [String] answerId
+    attr_accessor :answerId
+    # @attr [Integer] pageId
+    attr_accessor :pageId
+    # @attr [String] action
+    attr_accessor :action
+    # @attr [String] operator
+    attr_accessor :operator
+    # @attr [String] operatorComparer
+    attr_accessor :operatorComparer
+
+  end # Questionnaire::Question::Conditions
+end # GroupDocs

data/lib/groupdocs/signature.rb

@@ -34,326 +34,30 @@ module GroupDocs
     end
 
 
+    # Get signature fields.
     #
-    # Fill in envelope field.
-    #
-    # @param [String] envelope Envelope GUID
-    # @param [String] document Document GUID
-    # @param [String] recipient Recipient GUID
-    # @param [String] field Field GUID
-    # @param [Hash] post_data Data to be placed in field
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def fill_envelope!(envelope, document, recipient, field, post_data, access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/signature/public/envelopes/#{envelope.guid}/documents/#{document.guid}/recipient/#{recipient.guid}/field/#{field.guid}"
-        request[:request_body] = post_data
-      end.execute!
-
-      json[:field]
-    end
-
-    #
-    # Sing envelope
-    #
-    # @param [String] envelope Envelope GUID
-    # @param [String] recipient Recipient GUID
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
-    # @return [Array]
-    #
-    def sign_envelope!(envelope, recipient, access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/signature/public/envelopes/#{envelope.guid}/recipient/#{recipient.id}/sign"
-      end.execute!
-    end
-
-    #
-    # Sing envelope
-    #
-    # @param [String] envelope Envelope GUID
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
+    # @return [Array<GroupDocs::Signature>]
     #
-    def recipient!(envelope, access = {})
+    def self.get_list!( access = {})
       json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
-        request[:path] = "/signature/public/envelopes/#{envelope.guid}/recipient/"
+        request[:path] = '/signature/{{client_id}}/fields'
       end.execute!
 
-      json[:recipient]
+      json[:fields]
     end
 
-    #
-    # Get signature field for document in envelope per recipient.
-    #
-    # @param [String] envelope Envelope GUID
-    # @param [Hash] options
-    # @option options [String] :document Document GUID
-    # @option options [String] :recipient Recipient GUID
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def field_envelope_recipient!(envelope, options = {}, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/signature/public/envelopes/#{envelope.guid}/fields"
-      end
-      api.add_params(options)
-      json = api.execute!
 
-      json[:field]
-    end
 
     #
-    # Get signed envelope field data.
+    #  Changed in release 1.5.8
     #
-    # @param [String] envelope Envelope GUID
-    # @param [String] recipient Recipient GUID
-    # @param [String] field Field GUID
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def field_envelope_date!(envelope, recipient, field,access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/signature/public/envelopes/#{envelope.guid}/fields/recipient/#{recipient.id}/field/#{field.id}"
-      end.execute!
-
-    end
-
     #
-    # Get signature envelope.
-    #
-    # @param [String] envelope Envelope GUID
-    # @param [String] recipient Recipient GUID
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def get_sign_envelope!(envelope, recipient, access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/signature/public/envelopes/#{envelope.guid}/recipient/#{recipient.id}"
-      end.execute!
-
-      json[:envelope]
-    end
-
-    #
-    # Get signature envelope.
-    #
-    # @param [String] envelope Envelope GUID
-    # @param [String] recipient Recipient GUID
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def get_signed_documents!(envelope, recipient, access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/signature/public/envelopes/#{envelope.guid}/recipient/#{recipient.id}/documents/get"
-      end.execute!
-    end
-
-    #
-    # Get signature envelope.
-    #
-    # @param [String] form Form GUID
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def fill_signature_form!(form, access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/signature/public/forms/#{form.id}/fill"
-      end.execute!
-
-      json[:participant]
-    end
-
-    #
-    # Fill form field.
-    #
-    # @param [String] form Form GUID
-    # @param [String] document Document GUID
-    # @param [String] participant Participant GUID
-    # @param [String] field Field GUID
-    # @param [String] authentication Authentication signature
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def fill_form_field!(form, document, participant, field, authentication, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/signature/public/forms/#{form.id}/documents/#{document.guid}/participant/#{participant.id}/field/#{field.id}"
-      end
-      api.add_params(:participantAuthSignature => authentication)
-      json = api.execute!
-
-      json[:field]
-    end
-
-    #
-    # Sign form.
-    #
-    # @param [String] form Form GUID
-    # @param [String] participant Participant GUID
-    # @param [String] authentication Authentication signature
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def sign_form!(form, participant, authentication, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/signature/public/forms/#{form}/participant/#{participant}/sign"
-      end
-      api.add_params(:participantAuthSignature => authentication)
-      json = api.execute!
-
-      json[:field]
-    end
-
-    #
-    #  Get form fields for document in form per participant
-    #
-    # @param [String] form Form GUID
-    # @param [Hash] options
-    # @option [String] document Document GUID
-    # @option [String] participant Participant GUID
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def get_sign_form!(form, options = {}, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/signature/public/forms/#{form.id}/fields"
-      end
-      api.add_params(options)
-      json = api.execute!
-
-      json[:field]
-    end
-
-    #
-    # Get signed form documents.
-    #
-    # @param [String] form Form GUID
-    # @param [String] participant Participant GUID
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def get_signed_documents_form!(path, name, form, participant, access = {})
-      response = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/signature/public/forms/#{form.id}/participant/#{participant.id}/documents/get"
-      end.execute!
-
-      filepath = "#{path}/#{name}."
-      Object::File.open(filepath, 'wb') do |file|
-        file.write(response)
-      end
-
-      filepath
-    end
-
-    #
-    # Get signature form participant.
-    #
-    # @param [String] form Form GUID
-    # @param [String] participant Participant GUID
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def get_sign_form_participant!(form, participant, access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/signature/public/forms/#{form}/participant/#{participant}"
-      end.execute!
-
-      json[:participant]
-    end
-
-    #
-    #  Sign document
-    #
-    # @param [String] document Document GUID
-    # @param [Hash] settings Settings of the signing document
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def sign_document!(document, settings = {}, access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :POST
-        request[:path] = "/signature/public/documents/#{document.guid}/sign"
-        request[:request_body] = settings
-      end.execute!
-
-      json[:jobId]
-    end
-	
-	 #
-    #  Get document fields
-    #
-    # @param [String] document Document GUID
-    # @param [Hash] settings Settings of the signing document
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array]
-    #
-    def self.get_document_fields!(document, access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/signature/public/documents/#{document}/fields"
-      end.execute!
-    end
-
-    #
-    #  Verify to document
+    # Verify to document
     #
     # @param [String] path Path to document GUID
     # @param [Hash] settings Settings of the signing document
@@ -362,29 +66,38 @@ module GroupDocs
     # @option access [String] :private_key
     # @return [Array]
     #
-    def self.verify!(path, access = {})
+    def self.verify!(filepath, access = {})
       Api::Request.new do |request|
         request[:access] = access
         request[:method] = :POST
         request[:path] = "/signature/public/verify"
-        request[:request_body] = path
+        request[:request_body] = Object::File.new(filepath, 'rb')
       end.execute!
     end
 
+
+
+    #
+    # Changed in release 1.5.8
     #
-    #  Sign document
+    #
+    # Sign document
     #
     # @param [String] job Job GUID
+    # @param [Hash] options 
+    # @option [Boolean] :public
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
     # @return [Array]
     #
-    def self.sign_document_status!(job, access = {})
+    def self.sign_document_status!(job, options = {}, access = {})
+
+        client_id = !!options[:public] ? 'public' : '{{client_id}}'
       json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
-        request[:path] = "/signature/public/documents/#{job}/status"
+        request[:path] = "/signature/#{client_id}/documents/#{job}/status"
       end.execute!
 
       Storage::File.new(:guid => json[:documents][0][:documentId])
@@ -392,6 +105,8 @@ module GroupDocs
 
 
 
+    #
+    # This method deleted from GroupDocs API
     #
     # Returns a list of all signatures for recipient.
     #
@@ -418,6 +133,7 @@ module GroupDocs
       end
     end
 
+
     # @attr [String] id
     attr_accessor :id
     # @attr [String] userGuid
@@ -471,6 +187,7 @@ module GroupDocs
     alias_accessor :initials_data,           :initialsData
     alias_accessor :created_time_stamp,      :createdTimeStamp
 
+
     #
     # Creates signature.
     #
@@ -498,6 +215,9 @@ module GroupDocs
       self.id = json[:signature][:id]
     end
 
+
+    #
+    # This method deleted from GroupDocs API
     #
     # Creates signature for recipient.
     #
@@ -523,6 +243,7 @@ module GroupDocs
       self.id = json[:signature][:id]
     end
 
+
     #
     # Deletes signature.
     #
@@ -538,6 +259,9 @@ module GroupDocs
       end.execute!
     end
 
+
+    #
+    # This method deleted from GroupDocs API
     #
     # Returns signature data.
     #
@@ -553,6 +277,10 @@ module GroupDocs
       end.execute!
     end
 
+
+
+    #
+    # This method deleted from GroupDocs API
     #
     # Returns initials data.
     #