groupdocs 1.5.3 → 1.5.4

data/lib/groupdocs/signature/envelope.rb

@@ -460,5 +460,61 @@ module GroupDocs
       end.execute!
     end
 
+    #
+    #  Get signed envelope document.
+    #
+    # @example
+    #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+    #   document = GroupDocs::Storage::Folder.list!.last.to_document
+    #   envelope.add_document! document
+    #
+    # @param [GroupDocs::Document] document
+    # @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_envelope!(document, access = {})
+      document.is_a?(GroupDocs::Document) or raise ArgumentError,
+                                                   "Document should be GroupDocs::Document object, received: #{document.inspect}"
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/document/#{document.file.guid}"
+      end.execute!
+
+    end
+
+    #
+    # Cancel envelope.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def cancel!( access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/cancel"
+      end.execute!
+    end
+
+    #
+    # Retry sign envelope.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def retry!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/retry"
+      end.execute!
+    end
+
   end # Signature::Envelope
 end # GroupDocs

data/lib/groupdocs/signature/form.rb

@@ -102,6 +102,9 @@ module GroupDocs
     attr_accessor :waterMarkText
     # @attr [String] waterMarkImage
     attr_accessor :waterMarkImage
+    # @attr [Boolean] notifyOwnerOnSign
+    attr_accessor :notifyOwnerOnSign
+
 
     # Human-readable accessors
     alias_accessor :owner_guid,                    :ownerGuid
@@ -114,6 +117,8 @@ module GroupDocs
     alias_accessor :can_participant_download_form, :canParticipantDownloadForm
     alias_accessor :water_mark_text,               :waterMarkText
     alias_accessor :water_mark_image,              :waterMarkImage
+    alias_accessor :notifyOwnerOnSign,             :notifyOwnerOnSign
+
 
     #
     # Converts status to human-readable format.
@@ -160,17 +165,19 @@ module GroupDocs
     # @raise [ArgumentError] if template is not GroupDocs::Signature::Template
     #
     def create!(options = {}, access = {})
-      template_id = options.delete(:template_id)
-      assembly_id = options.delete(:assembly_id)
-      options[:templateId] = template_id if template_id
-      options[:assemblyId] = assembly_id if assembly_id
+      #template_id = options.delete(:template_id)
+      #assembly_id = options.delete(:assembly_id)
+      #options[:templateId] = template_id if template_id
+      #options[:assemblyId] = assembly_id if assembly_id
 
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :POST
         request[:path] = '/signature/{{client_id}}/form'
         request[:request_body] = to_hash
+
       end
+
       api.add_params(options.merge(:name => name))
       json = api.execute!
 
@@ -209,12 +216,14 @@ module GroupDocs
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
+    # @param callbackUrl [String]:callbackUrl  Webhook Callback Url
     #
-    def publish!(access = {})
+    def publish!(callbackUrl, access = {})
       Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/signature/{{client_id}}/forms/#{id}/publish"
+        request[:request_body] = callbackUrl
       end.execute!
     end
 
@@ -373,5 +382,38 @@ module GroupDocs
       end.execute!
     end
 
+    #
+    # Modify signature form document
+    #
+    # @example
+    #   form = GroupDocs::Signature::Form.get!("g94h5g84hj9g4gf23i40j")
+    #   document = envelope.documents!.first
+    #   recipient = envelope.recipients!.first
+    #   field = envelope.fields!(document, recipient).first
+    #   field.name = "Field"
+    #   envelope.modify_field! field, document
+    #
+    #
+    # @param [GroupDocs::Document] document
+    # @param [Hash] options
+    # @option options [Integer] Order
+    # @option options [String] newDocumentGuid
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if document is not GroupDocs::Document
+    #
+    def modify_form_document!(document, options = {}, access = {})
+      document.is_a?(GroupDocs::Document) or raise ArgumentError,
+                                                   "Document should be GroupDocs::Document object, received: #{document.inspect}"
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/forms/#{form}/document/#{document.file.guid}/"
+        request[:request_body] = options
+      end.execute!
+    end
+
   end # Signature::Form
 end # GroupDocs

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

@@ -233,6 +233,43 @@ module GroupDocs
         end.execute!
       end
 
+      #
+      #  Rename signature template document
+      #
+      # @example Rename field from template
+      #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
+      #   document = template.documents!.first
+      #   template.rename_field! (new_name, document)
+      #
+      # @example Rename field from envelope
+      #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+      #   document = envelope.documents!.first
+      #   envelope.rename_field! (new_name, document)
+      #
+      # @example Rename field from form
+      #   envelope = GroupDocs::Signature::Form.get!("g94h5g84hj9g4gf23i40j")
+      #   document = envelope.documents!.first
+      #   envelope.rename_field! (new_name, document)
+      #
+      # @param [GroupDocs::Signature::Field] field
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @raise [ArgumentError] if field is not GroupDocs::Signature::Field
+      #
+      def rename_field!(new_name, document, access = {})
+        field.is_a?(GroupDocs::Signature::Field) or raise ArgumentError,
+                                                          "Field should be GroupDocs::Signature::Field object, received: #{field.inspect}"
+
+        api = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :PUT
+          request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/document/#{document.file.id}"
+        end
+         api.add_params(new_name).execute!
+
+      end
+
       #
       # Modifies field location.
       #

data/lib/groupdocs/storage/file.rb

@@ -53,6 +53,27 @@ module GroupDocs
         Storage::File.new(json)
       end
 
+
+      #
+      # Get shared file.
+      #
+      # @param [String] file_path
+      # @param [String] user_email
+      #
+      def get_shared_file!(user_email, file_path)
+        response = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :GET
+          request[:path] = "/storage/shared/#{user_email}/#{file_path}"
+        end.execute!
+
+        Object::File.open(file_path, 'wb') do |file|
+          file.write(response)
+        end
+
+        file_path
+      end
+
       #
       # Uploads web page as file.
       #
@@ -74,6 +95,53 @@ module GroupDocs
         Storage::File.new(json)
       end
 
+      #
+      # Uploads google page as file.
+      #
+      # @param [String] path
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Storage::File]
+      #
+      def upload_google!(path, file_id, access = {})
+        api = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = "/storage/{{client_id}}/google/files/#{path}/"
+        end
+
+        api.add_params(:file_id => file_id)
+        json = api.execute!
+
+        Storage::File.new(json)
+      end
+
+      #
+      # Uploads and unzip as file.
+      #
+      # @param [String] path
+      # @param [Hash] options
+      # @option description [String]
+      # @option archiveType [String]
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Storage::File]
+      #
+      def decompress!(path, file_zip, options = {}, access = {})
+        api = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = "/storage/{{client_id}}/decompress/#{path}/"
+          request[:request_body] = file_zip
+        end
+        api.add_params(options)
+        json = api.execute!
+
+        Storage::File.new(json)
+      end
+
       # @attr [Integer] id
       attr_accessor :id
       # @attr [String] guid
@@ -305,6 +373,21 @@ module GroupDocs
         end.execute!
       end
 
+      #
+      # Restore file from trash on server.
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      #
+      def restore_to_trash!(path, access = {})
+        Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :DELETE
+          request[:path] = "/storage/{{client_id}}/trash/#{path}/"
+        end.execute!
+      end
+
       #
       # Converts file to GroupDocs::Document.
       #

data/lib/groupdocs/subscription.rb

@@ -43,6 +43,201 @@ module GroupDocs
       new(json)
     end
 
+    #
+    # Simulate Assess For Pricing Plan.
+    #
+    # @param [String] discount_code Discount code
+    # @param [String] plan_id Subscription Plan Id
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array] Invoices
+    #
+    def self.invoices!(discount_code, plan_id, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/system/{{client_id}}/plans/#{plan_id}/discounts/#{discount_code}"
+      end.execute!
+
+      json[:invoices]
+    end
+
+    #
+    # Returns user subscription plan.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Subscription]
+    #
+    def self.subscription!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/system/{{client_id}}/subscription'
+      end.execute!
+
+    end
+
+    #
+    # Set subscription plan user plan.
+    # @param [Hash] plan Subscription Plan Info
+    # @param [String] product_id
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Subscription]
+    #
+    def self.set_subscription!(plan, product_id, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/system/{{client_id}}/subscriptions/#{product_id}"
+        request[:request_body] = plan
+      end.execute!
+
+      new(json)
+    end
+
+    #
+    # Set subscription plan user plan.
+    # @param [Hash] plan Update Subscription Plan Info
+    # @param [String] product_id
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Subscription]
+    #
+    def self.update_subscription!(plan, product_id, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/system/{{client_id}}/subscriptions/#{product_id}"
+        request[:request_body] = plan
+      end.execute!
+
+      new(json)
+    end
+
+    #
+    # Returns countries.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Subscription]
+    #
+    def self.get_countries!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/system/{{client_id}}/countries'
+      end.execute!
+
+      json[:countries]
+    end
+
+    #
+    # Returns states.
+    #
+    # @param [String] name Country name
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Subscription]
+    #
+    def self.get_states!(name, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/system/{{client_id}}/countries/#{name}/states"
+      end.execute!
+
+      json[:states]
+    end
+
+    #
+    # Set user billing address.
+    #
+    # @param [Hash] billing Billing address info
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Subscription]
+    #
+    def self.set_billing!(billing = {}, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/system/{{client_id}}/billingaddress"
+        request[:request_body] = billing
+      end.execute!
+
+      json[:billing_address]
+    end
+
+    #
+    # Get invoices.
+    #
+    # @param [Hash] options
+    # @option options [String] :pageNumber
+    # @option options [String] :pageSize
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array] Invoices
+    #
+    def self.get_invoices!(options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/system/{{client_id}}/invoices"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:invoices]
+    end
+
+    #
+    # Get subscription plans.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def self.get_plans!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/system/{{client_id}}/usage"
+      end
+
+      new(json)
+    end
+
+    #
+    # Returns purchase wizard info from billing provider.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [String] Url
+    #
+    def self.get_wizard!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/system/{{client_id}}/purchase/wizard"
+      end
+
+     json[:url]
+    end
+
+
+
+
     #
     # Returns all subscription plans for family.
     #
@@ -63,6 +258,29 @@ module GroupDocs
       end
     end
 
+    #
+    # Returns suggestions for a specified term
+    #
+    # @param [String] term A term to return suggestions for
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Subscription>]
+    #
+    def self.get_term!(term , access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/system/{{client_id}}/terms/#{term}/suggestions"
+      end.execute!
+
+      json[:suggestions].map do |element|
+        new(element)
+      end
+    end
+
+
+
     # @attr [Integer] Id
     attr_accessor :Id
     # @attr [String] Name