groupdocs 2.2.0 → 2.3.0

data/lib/groupdocs/questionnaire/collector.rb

@@ -1,335 +1,335 @@
-module GroupDocs
-  class Questionnaire::Collector < Api::Entity
-
-    include Api::Helpers::Status
-
-    #
-    # Returns collector by its guid.
-    #
-    # @param [String] guid
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::Questionnaire::Collector]
-    #
-    def self.get!(guid, access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}"
-      end.execute!
-
-      collector = json[:collector]
-      collector.merge!(:questionnaire => Questionnaire.new(:id => collector[:questionnaire_id]))
-
-      new(collector)
-    end
-
-    # @attr [Integer] id
-    attr_accessor :id
-    # @attr [String] guid
-    attr_accessor :guid
-    # @attr [GroupDocs::Questionnaire] questionnaire
-    attr_accessor :questionnaire
-    # @attr [Integer] questionnaire_id
-    attr_accessor :questionnaire_id
-    # @attr [Symbol] status
-    attr_accessor :status
-    # @attr [Symbol] type
-    attr_accessor :type
-    # @attr [Integer] resolved_executions
-    attr_accessor :resolved_executions
-    # @attr [Array<String>] emails
-    attr_accessor :emails
-    # @attr [Time] modified
-    attr_accessor :modified
-
-    #
-    # Creates new GroupDocs::Questionnaire::Collector.
-    #
-    # @raise [ArgumentError] If questionnaire is not passed or is not an instance of GroupDocs::Questionnaire
-    #
-    def initialize(options = {}, &blk)
-      super(options, &blk)
-      questionnaire.is_a?(GroupDocs::Questionnaire) or raise ArgumentError,
-        "You have to pass GroupDocs::Questionnaire object: #{questionnaire.inspect}."
-    end
-
-    #
-    # Converts status to human-readable format.
-    # @return [Symbol]
-    #
-    def status
-      parse_status(@status)
-    end
-
-    #
-    # Updates type with machine-readable format.
-    #
-    # @param [Symbol] type
-    #
-    def type=(type)
-      @type = type.is_a?(Symbol) ? type.to_s.capitalize : type
-    end
-
-    #
-    # Converts type to human-readable format.
-    # @return [Symbol]
-    #
-    def type
-      parse_status(@type)
-    end
-
-    #
-    # Converts timestamp which is return by API server to Time object.
-    # @return [Time]
-    #
-    def modified
-      Time.at(@modified / 1000)
-    end
-
-    #
-    # Adds collector.
-    #
-    # @example
-    #   questionnaire = GroupDocs::Questionnaire.get!(1)
-    #   collector = GroupDocs::Questionnaire::Collector.new(questionnaire: questionnaire)
-    #   collector.type = :link
-    #   collector.add!
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def add!(access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :POST
-        request[:path] = "/merge/{{client_id}}/questionnaires/#{questionnaire.guid}/collectors"
-        request[:request_body] = to_hash
-      end.execute!
-
-      self.id   = json[:collector_id]
-      self.guid = json[:collector_guid]
-    end
-
-    #
-    # Updates collector.
-    #
-    # @example
-    #   questionnaire = GroupDocs::Questionnaire.get!(1)
-    #   collector = questionnaire.collectors!.first
-    #   collector.type = :embedded
-    #   collector.update!
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def update!(access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}"
-        request[:request_body] = to_hash
-      end.execute!
-    end
-
-    #
-    # Removes collector.
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def remove!(access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :DELETE
-        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}"
-      end.execute!
-    end
-
-    #
-    # Returns an array of questionnaire collector executions.
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array<GroupDocs::Questionnaire::Execution>]
-    #
-    def executions!(access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/executions"
-      end.execute!
-
-      json[:executions].map do |execution|
-        Questionnaire::Execution.new(execution)
-      end
-    end
-
-    #
-    # Adds new questionnaire execution.
-    #
-    # @example
-    #   questionnaire = GroupDocs::Questionnaire.get!(1)
-    #   collector = questionnaire.collectors!.first
-    #   execution = GroupDocs::Questionnaire::Execution.new
-    #   execution.executive = GroupDocs::User.new(primary_email: 'john@smith.com')
-    #   # make sure to save execution as it has updated attributes
-    #   execution = collector.add_execution!(execution)
-    #   #=> #<GroupDocs::Questionnaire::Execution @id=1, @questionnaire_id=1>
-    #
-    # @param [GroupDocs::Questionnaire::Execution] execution
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::Questionnaire::Execution] updated execution
-    #
-    def add_execution!(execution, access = {})
-      execution.is_a?(GroupDocs::Questionnaire::Execution) or raise ArgumentError,
-        "Execution should be GroupDocs::Questionnaire::Execution object, received: #{execution.inspect}"
-
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :POST
-        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/executions"
-        request[:request_body] = execution.to_hash
-      end.execute!
-
-      execution.id = json[:execution_id]
-      execution.guid = json[:execution_guid]
-      execution.collector_id = json[:collector_id]
-
-      execution
-    end
-
-    #
-    # Creates new job to merge datasource into questionnaire collector.
-    #
-    # @example
-    #   # get template and its first field
-    #   document = GroupDocs::Document.templates!.first
-    #   field = document.fields!.first
-    #   # create questionnaire
-    #   answer = GroupDocs::Questionnaire::Question::Answer.new(text: 'Text', value: 'Value1')
-    #   question = GroupDocs::Questionnaire::Question.new(field: field.name, text: 'Question', answers: [answer])
-    #   page = GroupDocs::Questionnaire::Page.new(number: field.page, questions: [question])
-    #   questionnaire = GroupDocs::Questionnaire.new(name: 'Questionnaire', description: 'Description', pages: [page])
-    #   questionnaire.create!
-    #   # add questionnaire to document
-    #   document.add_questionnaire! questionnaire
-    #   # create collector
-    #   collector = GroupDocs::Questionnaire::Collector.new(questionnaire: questionnaire)
-    #   collector.type = :link
-    #   collector.add!
-    #   # create datasource and its field
-    #   field = GroupDocs::DataSource::Field.new(field: field.name, values: %w(test1 test2))
-    #   datasource = GroupDocs::DataSource.new(fields: [field])
-    #   datasource.add!
-    #   # fill collector with datasrouce and send results to email
-    #   collector.fill!(datasource, email_results: true)
-    #
-    # @param [GroupDocs::DataSource] datasource
-    # @param [Hash] options
-    # @option options [Boolean] :new_type New file format type
-    # @option options [Boolean] :email_results Set to true if converted document should be emailed
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::Job]
-    #
-    # @raise [ArgumentError] if datasource is not GroupDocs::DataSource object
-    #
-    def fill!(datasource, options = {}, access = {})
-      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
-        "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
-
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :POST
-        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/datasources/#{datasource.id}"
-      end
-      api.add_params(options)
-      json = api.execute!
-
-      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
-
-    #
-    # Added in release 1.7.0
-    #
-    # Decorate questionnaire collector
-    #
-    # @example
-    #   questionnaire = GroupDocs::Questionnaire.get!(1)
-    #   collector = questionnaire.collectors!.first
-    #   style = GroupDocs::Questionnaire::QuestionnaireCollectorStyle.new
-    #   style.collectorId = collector.id
-    #   title = GroupDocs::Questionnaire::QuestionnaireCollectorStyle::Title.new
-    #   title.color = 'blue'
-    #   style.title = title
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def decorate!(style, access = {})
-      style.is_a?(GroupDocs::Questionnaire::QuestionnaireCollectorStyle) or raise ArgumentError,
-                                                       "Style should be GroupDocs::Questionnaire::QuestionnaireCollectorStyle object, received: #{style.inspect}"
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :POST
-        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/decorate"
-        request[:request_body] = style
-      end.execute!
-    end
-
-
-    #
-    # Added in release 1.7.0
-    #
-    # Returns questionnaire collector style
-    #
-    # @example
-    #   questionnaire = GroupDocs::Questionnaire.get!(1)
-    #   collector = questionnaire.collectors!.first
-    #   collector.decorate!
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def get_decorate!(access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/merge/{{client_id}}/questionnaires/collector/#{guid}/style"
-      end.execute!
-    end
-
-  end # Questionnaire::Collector
-end # GroupDocs
+module GroupDocs
+  class Questionnaire::Collector < Api::Entity
+
+    include Api::Helpers::Status
+
+    #
+    # Returns collector by its guid.
+    #
+    # @param [String] guid
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Questionnaire::Collector]
+    #
+    def self.get!(guid, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}"
+      end.execute!
+
+      collector = json[:collector]
+      collector.merge!(:questionnaire => Questionnaire.new(:id => collector[:questionnaire_id]))
+
+      new(collector)
+    end
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [GroupDocs::Questionnaire] questionnaire
+    attr_accessor :questionnaire
+    # @attr [Integer] questionnaire_id
+    attr_accessor :questionnaire_id
+    # @attr [Symbol] status
+    attr_accessor :status
+    # @attr [Symbol] type
+    attr_accessor :type
+    # @attr [Integer] resolved_executions
+    attr_accessor :resolved_executions
+    # @attr [Array<String>] emails
+    attr_accessor :emails
+    # @attr [Time] modified
+    attr_accessor :modified
+
+    #
+    # Creates new GroupDocs::Questionnaire::Collector.
+    #
+    # @raise [ArgumentError] If questionnaire is not passed or is not an instance of GroupDocs::Questionnaire
+    #
+    def initialize(options = {}, &blk)
+      super(options, &blk)
+      questionnaire.is_a?(GroupDocs::Questionnaire) or raise ArgumentError,
+        "You have to pass GroupDocs::Questionnaire object: #{questionnaire.inspect}."
+    end
+
+    #
+    # Converts status to human-readable format.
+    # @return [Symbol]
+    #
+    def status
+      parse_status(@status)
+    end
+
+    #
+    # Updates type with machine-readable format.
+    #
+    # @param [Symbol] type
+    #
+    def type=(type)
+      @type = type.is_a?(Symbol) ? type.to_s.capitalize : type
+    end
+
+    #
+    # Converts type to human-readable format.
+    # @return [Symbol]
+    #
+    def type
+      parse_status(@type)
+    end
+
+    #
+    # Converts timestamp which is return by API server to Time object.
+    # @return [Time]
+    #
+    def modified
+      Time.at(@modified / 1000)
+    end
+
+    #
+    # Adds collector.
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = GroupDocs::Questionnaire::Collector.new(questionnaire: questionnaire)
+    #   collector.type = :link
+    #   collector.add!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def add!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{questionnaire.guid}/collectors"
+        request[:request_body] = to_hash
+      end.execute!
+
+      self.id   = json[:collector_id]
+      self.guid = json[:collector_guid]
+    end
+
+    #
+    # Updates collector.
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = questionnaire.collectors!.first
+    #   collector.type = :embedded
+    #   collector.update!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def update!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}"
+        request[:request_body] = to_hash
+      end.execute!
+    end
+
+    #
+    # Removes collector.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def remove!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}"
+      end.execute!
+    end
+
+    #
+    # Returns an array of questionnaire collector executions.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Questionnaire::Execution>]
+    #
+    def executions!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/executions"
+      end.execute!
+
+      json[:executions].map do |execution|
+        Questionnaire::Execution.new(execution)
+      end
+    end
+
+    #
+    # Adds new questionnaire execution.
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = questionnaire.collectors!.first
+    #   execution = GroupDocs::Questionnaire::Execution.new
+    #   execution.executive = GroupDocs::User.new(primary_email: 'john@smith.com')
+    #   # make sure to save execution as it has updated attributes
+    #   execution = collector.add_execution!(execution)
+    #   #=> #<GroupDocs::Questionnaire::Execution @id=1, @questionnaire_id=1>
+    #
+    # @param [GroupDocs::Questionnaire::Execution] execution
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Questionnaire::Execution] updated execution
+    #
+    def add_execution!(execution, access = {})
+      execution.is_a?(GroupDocs::Questionnaire::Execution) or raise ArgumentError,
+        "Execution should be GroupDocs::Questionnaire::Execution object, received: #{execution.inspect}"
+
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/executions"
+        request[:request_body] = execution.to_hash
+      end.execute!
+
+      execution.id = json[:execution_id]
+      execution.guid = json[:execution_guid]
+      execution.collector_id = json[:collector_id]
+
+      execution
+    end
+
+    #
+    # Creates new job to merge datasource into questionnaire collector.
+    #
+    # @example
+    #   # get template and its first field
+    #   document = GroupDocs::Document.templates!.first
+    #   field = document.fields!.first
+    #   # create questionnaire
+    #   answer = GroupDocs::Questionnaire::Question::Answer.new(text: 'Text', value: 'Value1')
+    #   question = GroupDocs::Questionnaire::Question.new(field: field.name, text: 'Question', answers: [answer])
+    #   page = GroupDocs::Questionnaire::Page.new(number: field.page, questions: [question])
+    #   questionnaire = GroupDocs::Questionnaire.new(name: 'Questionnaire', description: 'Description', pages: [page])
+    #   questionnaire.create!
+    #   # add questionnaire to document
+    #   document.add_questionnaire! questionnaire
+    #   # create collector
+    #   collector = GroupDocs::Questionnaire::Collector.new(questionnaire: questionnaire)
+    #   collector.type = :link
+    #   collector.add!
+    #   # create datasource and its field
+    #   field = GroupDocs::DataSource::Field.new(field: field.name, values: %w(test1 test2))
+    #   datasource = GroupDocs::DataSource.new(fields: [field])
+    #   datasource.add!
+    #   # fill collector with datasrouce and send results to email
+    #   collector.fill!(datasource, email_results: true)
+    #
+    # @param [GroupDocs::DataSource] datasource
+    # @param [Hash] options
+    # @option options [Boolean] :new_type New file format type
+    # @option options [Boolean] :email_results Set to true if converted document should be emailed
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Job]
+    #
+    # @raise [ArgumentError] if datasource is not GroupDocs::DataSource object
+    #
+    def fill!(datasource, options = {}, access = {})
+      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
+        "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/datasources/#{datasource.id}"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      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
+
+    #
+    # Added in release 1.7.0
+    #
+    # Decorate questionnaire collector
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = questionnaire.collectors!.first
+    #   style = GroupDocs::Questionnaire::QuestionnaireCollectorStyle.new
+    #   style.collectorId = collector.id
+    #   title = GroupDocs::Questionnaire::QuestionnaireCollectorStyle::Title.new
+    #   title.color = 'blue'
+    #   style.title = title
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def decorate!(style, access = {})
+      style.is_a?(GroupDocs::Questionnaire::QuestionnaireCollectorStyle) or raise ArgumentError,
+                                                       "Style should be GroupDocs::Questionnaire::QuestionnaireCollectorStyle object, received: #{style.inspect}"
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/decorate"
+        request[:request_body] = style
+      end.execute!
+    end
+
+
+    #
+    # Added in release 1.7.0
+    #
+    # Returns questionnaire collector style
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = questionnaire.collectors!.first
+    #   collector.decorate!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def get_decorate!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/collector/#{guid}/style"
+      end.execute!
+    end
+
+  end # Questionnaire::Collector
+end # GroupDocs