Module: GroupDocs::Signature::EntityMethods
Overview
Envelope and template entities share the same set of methods.
Defined Under Namespace
Modules: ClassMethods
Class Method Summary collapse
Instance Method Summary collapse
-
#create!(options = {}, access = {}) ⇒ Object
Creates template or envelope.
-
#delete!(access = {}) ⇒ Object
Deletes template, envelope or form.
-
#modify!(access = {}) ⇒ Object
Modifies template, envelope or form.
-
#rename!(name, access = {}) ⇒ Object
Renames template, envelope or form.
Class Method Details
.included(klass) ⇒ Object
12 13 14 |
# File 'lib/groupdocs/signature/shared/entity_methods.rb', line 12 def self.included(klass) klass.extend ClassMethods end |
Instance Method Details
#create!(options = {}, access = {}) ⇒ Object
Creates template or envelope.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/groupdocs/signature/shared/entity_methods.rb', line 60 def create!( = {}, access = {}) template_id = .delete(:template_id) envelope_id = .delete(:envelope_id) [:templateId] = template_id if template_id [:envelopeId] = envelope_id if envelope_id api = Api::Request.new do |request| request[:access] = access request[:method] = :POST request[:path] = "/signature/{{client_id}}/#{class_name}" request[:request_body] = to_hash end api.add_params(.merge(:name => name)) json = api.execute! self.id = json[class_name.to_sym][:id] end |
#delete!(access = {}) ⇒ Object
Deletes template, envelope or form.
134 135 136 137 138 139 140 |
# File 'lib/groupdocs/signature/shared/entity_methods.rb', line 134 def delete!(access = {}) Api::Request.new do |request| request[:access] = access request[:method] = :DELETE request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}" end.execute! end |
#modify!(access = {}) ⇒ Object
Modifies template, envelope or form.
97 98 99 100 101 102 103 104 |
# File 'lib/groupdocs/signature/shared/entity_methods.rb', line 97 def modify!(access = {}) Api::Request.new do |request| request[:access] = access request[:method] = :POST request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}" request[:request_body] = to_hash end.execute! end |
#rename!(name, access = {}) ⇒ Object
Renames template, envelope or form.
114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/groupdocs/signature/shared/entity_methods.rb', line 114 def rename!(name, access = {}) api = Api::Request.new do |request| request[:access] = access request[:method] = :PUT request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}" end key = (class_name == 'form' ? :new_name : :name ) api.add_params(key => name) api.execute! self.name = name end |