added delete and restore envelope how to code snippet

Author: Balaji Jayaraman

app/controllers/e_sign/eeg045_delete_restore_envelope_controller.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative '../../services/utils'
+
+class ESign::Eeg045DeleteRestoreEnvelopeController < EgController
+  before_action -> { check_auth('eSignature') }
+  before_action -> { @example = Utils::ManifestUtils.new.get_example(@manifest, 45, 'eSignature') }
+
+  DELETE_FOLDER_ID = 'recyclebin'
+
+  def delete_envelope
+    args = {
+      account_id: session['ds_account_id'],
+      base_path: session['ds_base_path'],
+      access_token: session['ds_access_token'],
+      envelope_id: param_gsub(params['envelope_id']),
+      delete_folder_id: DELETE_FOLDER_ID
+    }
+
+    delete_restore_envelope_service = ESign::Eg045DeleteRestoreEnvelopeService.new
+
+    delete_restore_envelope_service.delete_envelope args
+
+    session[:envelope_id] = args[:envelope_id]
+    additional_page_data = @example['AdditionalPage'].find { |p| p['Name'] == 'envelope_is_deleted' }
+    @title = @example['ExampleName']
+    @message = format_string(additional_page_data['ResultsPageText'], args[:envelope_id])
+    @redirect_url = "/#{session[:eg]}restore"
+
+    render 'ds_common/example_done'
+  end
+
+  def restore_envelope
+    folder_name = param_gsub(params['folder_name'])
+    args = {
+      account_id: session['ds_account_id'],
+      base_path: session['ds_base_path'],
+      access_token: session['ds_access_token'],
+      envelope_id: param_gsub(session[:envelope_id]),
+      from_folder_id: DELETE_FOLDER_ID
+    }
+
+    delete_restore_envelope_service = ESign::Eg045DeleteRestoreEnvelopeService.new
+
+    folders = delete_restore_envelope_service.get_folders args
+    args[:folder_id] = Utils::DocuSignUtils.new.get_folder_id_by_name(folders.folders, folder_name)
+
+    if args[:folder_id].nil? || args[:folder_id].empty?
+      additional_page_data = @example['AdditionalPage'].find { |p| p['Name'] == 'folder_does_not_exist' }
+      @title = @example['ExampleName']
+      @message = format_string(additional_page_data['ResultsPageText'], folder_name)
+      @redirect_url = "/#{session[:eg]}restore"
+
+      return render 'ds_common/example_done'
+    end
+
+    delete_restore_envelope_service.move_envelope_to_folder args
+
+    session[:envelope_id] = args[:envelope_id]
+    @title = @example['ExampleName']
+    @message = format_string(@example['ResultsPageText'], session[:envelope_id], args[:folder_id], folder_name)
+    render 'ds_common/example_done'
+  end
+
+  def get_delete_envelope
+    get
+    @envelope_id = session[:envelope_id]
+    @submit_button_text = @manifest['SupportingTexts']['HelpingTexts']['SubmitButtonDeleteText']
+
+    render 'e_sign/eeg045_delete_restore_envelope/delete'
+  end
+
+  def get_restore_envelope
+    return redirect_to "/#{session[:eg]}" if session[:envelope_id].nil?
+
+    get
+    @envelope_id = session[:envelope_id]
+    @submit_button_text = @manifest['SupportingTexts']['HelpingTexts']['SubmitButtonRestoreText']
+
+    render 'e_sign/eeg045_delete_restore_envelope/restore'
+  end
+end

app/services/api_creator.rb

@@ -49,4 +49,12 @@ def create_group_api(args)
     api_client.default_headers['Authorization'] = "Bearer #{args[:access_token]}"
     DocuSign_eSign::GroupsApi.new api_client
   end
+
+  def create_folders_api(args)
+    configuration = DocuSign_eSign::Configuration.new
+    configuration.host = args[:base_path]
+    api_client = DocuSign_eSign::ApiClient.new configuration
+    api_client.default_headers['Authorization'] = "Bearer #{args[:access_token]}"
+    DocuSign_eSign::FoldersApi.new api_client
+  end
 end

app/services/e_sign/eg045_delete_restore_envelope_service.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class ESign::Eg045DeleteRestoreEnvelopeService
+  include ApiCreator
+
+  def delete_envelope(args)
+    #ds-snippet-start:eSign45Step2
+    folders_api = create_folders_api(args)
+    #ds-snippet-end:eSign45Step2
+
+    #ds-snippet-start:eSign45Step3
+    folders_request = DocuSign_eSign::FoldersRequest.new
+    folders_request.envelope_ids = [args[:envelope_id]]
+    #ds-snippet-end:eSign45Step3
+
+    #ds-snippet-start:eSign45Step4
+    folders_api.move_envelopes(args[:account_id], args[:delete_folder_id], folders_request)
+    #ds-snippet-end:eSign45Step4
+  end
+
+  def move_envelope_to_folder(args)
+    folders_api = create_folders_api(args)
+
+    #ds-snippet-start:eSign45Step6
+    folders_request = DocuSign_eSign::FoldersRequest.new
+    folders_request.envelope_ids = [args[:envelope_id]]
+    folders_request.from_folder_id = args[:from_folder_id]
+
+    folders_api.move_envelopes(args[:account_id], args[:folder_id], folders_request)
+    #ds-snippet-end:eSign45Step6
+  end
+
+  def get_folders(args)
+    folders_api = create_folders_api(args)
+
+    #ds-snippet-start:eSign45Step5
+    folders_api.list(args[:account_id])
+    #ds-snippet-end:eSign45Step5
+  end
+end

app/services/utils.rb

@@ -29,6 +29,19 @@ def get_user_id(args)
       user_info = api_client.get_user_info(args[:access_token])
       user_info.sub
     end
+
+    def get_folder_id_by_name(folders, folder_name)
+      folders.each do |folder|
+        return folder.folder_id if folder.name.downcase == folder_name.downcase
+
+        if folder.folders&.any?
+          folder_id = get_folder_id_by_name(folder.folders, folder_name)
+          return folder_id if folder_id
+        end
+      end
+
+      nil
+    end
   end
 
   class FileUtils

app/services/webforms/eg002_create_remote_instance_service.rb

@@ -57,16 +57,20 @@ def create_web_form_instance(form_id)
       'Company' => 'Tally',
       'JobTitle' => 'Programmer Writer'
     }
-    recipient = DocuSign_WebForms::CreateInstanceRequestBodyRecipients.new({
-      'roleName' => 'signer',
-      'name' => args[:signer_name],
-      'email' => args[:signer_email]
-    })
-    web_form_req_object = DocuSign_WebForms::CreateInstanceRequestBody.new({
-      'formValues' => web_form_values,
-      'recipients' => [recipient],
-      'sendOption' => 'now'
-    })
+    recipient = DocuSign_WebForms::CreateInstanceRequestBodyRecipients.new(
+      {
+        'roleName' => 'signer',
+        'name' => args[:signer_name],
+        'email' => args[:signer_email]
+      }
+    )
+    web_form_req_object = DocuSign_WebForms::CreateInstanceRequestBody.new(
+      {
+        'formValues' => web_form_values,
+        'recipients' => [recipient],
+        'sendOption' => 'now'
+      }
+    )
     #ds-snippet-end:WebForms2Step4
 
     #ds-snippet-start:WebForms2Step5

app/views/e_sign/eeg045_delete_restore_envelope/delete.html.erb

@@ -0,0 +1,21 @@
+<%= render('partials/example_info') %>
+
+<% form_index = 0 %>
+<% envelope_id_index = 0 %>
+
+<form class="eg" action="" method="post" data-busy="form">
+  <% if @example["Forms"][form_index]["FormName"] %>
+    <%= sanitize @example["Forms"][form_index]["FormName"] %>
+  <% end %>
+
+  <div class="form-group">
+    <label for="envelope_id"><%= @example["Forms"][form_index]["Inputs"][envelope_id_index]["InputName"] %></label>
+    <input type="text" class="form-control" id="envelope_id" name="envelope_id"
+           aria-describedby="envelope_id_help" value="<%= @envelope_id %>" required
+           placeholder="<%= @example["Forms"][form_index]["Inputs"][envelope_id_index]["InputPlaceholder"] %>">
+    <small id="envelope_id_help" class="form-text text-muted"><%= @manifest["SupportingTexts"]["HelpingTexts"]["DefaultEnvelopeId"] %></small>
+  </div>
+
+  <%= render('partials/submit_button') %>
+</form>
+

app/views/e_sign/eeg045_delete_restore_envelope/restore.html.erb

@@ -0,0 +1,21 @@
+<h4><%= @example["ExampleName"] %></h4>
+<p><%= sanitize @example["ExampleDescription"] %></p>
+<%= sanitize format_string(@manifest["SupportingTexts"]["HelpingTexts"]["EnvelopeWillBeRestored"], @envelope_id) %>
+
+<% form_index = 0 %>
+<% folder_name_index = 1 %>
+
+<form class="eg" action="" method="post" data-busy="form">
+  <% if @example["Forms"][form_index]["FormName"] %>
+    <%= sanitize @example["Forms"][form_index]["FormName"] %>
+  <% end %>
+
+  <div class="form-group">
+    <label for="folder_name"><%= @example["Forms"][form_index]["Inputs"][folder_name_index]["InputName"] %></label>
+    <input type="text" class="form-control" id="folder_name" name="folder_name" required
+           placeholder="<%= @example["Forms"][form_index]["Inputs"][folder_name_index]["InputPlaceholder"] %>">
+  </div>
+
+  <%= render('partials/submit_button') %>
+</form>
+

app/views/partials/_example_info.erb

@@ -5,8 +5,8 @@
   <p><a target='_blank' href='<%= @documentation %>'>Documentation</a> about this example.</p>
 <% end %>
 
-<% if @example["Note"] %>
-  <%= sanitize @example["Note"] %>
+<% if @example["Notes"] %>
+  <%= sanitize @example["Notes"] %>
 <% end %>
 
 <% if @example["LinksToAPIMethod"] %>

app/views/partials/_submit_button.erb

@@ -1 +1 @@
-<button type="submit" class="btn btn-docu"><%= sanitize @manifest["SupportingTexts"]["SubmitButton"] %></button>
+<button type="submit" class="btn btn-docu"><%= sanitize @submit_button_text || @manifest["SupportingTexts"]["SubmitButton"] %></button>

config/routes.rb

@@ -231,6 +231,11 @@
 
     get 'eeg044' => 'eeg044_focused_view#get'
     post 'eeg044' => 'eeg044_focused_view#create'
+
+    get 'eeg045' => 'eeg045_delete_restore_envelope#get_delete_envelope'
+    post 'eeg045' => 'eeg045_delete_restore_envelope#delete_envelope'
+    get 'eeg045restore' => 'eeg045_delete_restore_envelope#get_restore_envelope'
+    post 'eeg045restore' => 'eeg045_delete_restore_envelope#restore_envelope'
   end
 
   scope module: 'connect' do