Merge branch 'master' of github.com:docusign/code-examples-ruby-private

Author: karissarjacobsen

Gemfile

@@ -66,11 +66,11 @@ group :test do
   gem 'chromedriver-helper', '~> 2.1.1'
 end
 
-gem 'docusign_esign', '~> 3.10.0.rc1'
+gem 'docusign_esign', '~> 3.13.0.rc1'
 gem 'docusign_monitor', '~> 1.0.0'
-gem 'docusign_rooms', '~> 1.1.0.rc1'
+gem 'docusign_rooms', '~> 1.2.0.rc1'
 gem 'docusign_click', '~> 1.0.0'
-gem 'docusign_admin', '~> 1.0.0.beta'
+gem 'docusign_admin', '~> 1.0.0'
 gem 'omniauth-oauth2', '~> 1.7.1'
 gem 'omniauth-rails_csrf_protection'
 

Gemfile.lock

@@ -87,7 +87,8 @@ GEM
     coffee-script-source (1.12.2)
     concurrent-ruby (1.1.9)
     crass (1.0.6)
-    docusign_admin (1.0.0.beta)
+    docusign_admin (1.0.0)
+      addressable (~> 2.7, >= 2.7.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -96,7 +97,8 @@ GEM
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
-    docusign_esign (3.10.0)
+    docusign_esign (3.13.0.rc1)
+      addressable (~> 2.7, >= 2.7.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -105,7 +107,8 @@ GEM
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
-    docusign_rooms (1.1.0)
+    docusign_rooms (1.2.0.rc1)
+      addressable (~> 2.7, >= 2.7.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -288,11 +291,11 @@ DEPENDENCIES
   capybara (~> 3.31.0)
   chromedriver-helper (~> 2.1.1)
   coffee-rails (~> 5.0.0)
-  docusign_admin (~> 1.0.0.beta)
+  docusign_admin (~> 1.0.0)
   docusign_click (~> 1.0.0)
-  docusign_esign (~> 3.10.0.rc1)
+  docusign_esign (~> 3.13.0.rc1)
   docusign_monitor (~> 1.0.0)
-  docusign_rooms (~> 1.1.0.rc1)
+  docusign_rooms (~> 1.2.0.rc1)
   jbuilder (~> 2.10.0)
   listen (~> 3.2.1)
   omniauth-oauth2 (~> 1.7.1)

app/services/e_sign/eg031_bulk_sending_envelopes_service.rb

@@ -25,40 +25,53 @@ def initialize(request, session)
   end
 
   def call
-    # Step 1. Obtain your OAuth token
+    # Construct your API headers
+    # Step 2 start
     configuration = DocuSign_eSign::Configuration.new
     configuration.host = args[:base_path]
     api_client = DocuSign_eSign::ApiClient.new configuration
-
-    # Step 2. Construct your API headers
     construct_api_headers(api_client)
+    # Step end
 
-    #  Step 3. Create and submit the bulk sending list
+    # Create and submit the bulk sending list
+    # Step 3-1 start
     bulk_envelopes_api = DocuSign_eSign::BulkEnvelopesApi.new api_client
     bulk_sending_list = create_bulk_sending_list
     bulk_list = bulk_envelopes_api.create_bulk_send_list(args[:account_id], bulk_sending_list)
     bulk_list_id  = bulk_list.list_id
+    # Step 3-1 end
 
-    # Step 4. Create the draft envelope
+    # Create the draft envelope
+    # Step 4-1 start
     envelope_api = create_envelope_api(args)
     envelope_definition = make_envelope
     envelope = envelope_api.create_envelope(args[:account_id], envelope_definition, options = DocuSign_eSign::CreateEnvelopeOptions.default)
     envelope_id = envelope.envelope_id
+    # Step 4-1 end
 
-    # Step 5. Attach your bulk list ID to the envelope
+    # Attach your bulk list ID to the envelope
+    # Step 5-1 start
     envelope_api.create_custom_fields(args[:account_id], envelope_id, custom_fields(bulk_list_id))
+    # Step 5-1 end
 
-    # Step 6. Add placeholder recipients
-    recipients = DocuSign_eSign::Recipients.new(signers: recipients_data)
+    # Add placeholder recipients
+    # Step 6-1 start
+    recipients = recipients_data
+    recipients = DocuSign_eSign::Recipients.new(signers: [recipients[0]], cc: [recipients[1]])
     envelope_api.create_recipient(args[:account_id], envelope_id, recipients, options = DocuSign_eSign::CreateRecipientOptions.default)
+    # Step 6-1 end
 
-     # Step 7. Initiate bulk send
+    # Initiate bulk send
+    # Step 7 start
     bulk_send_request = DocuSign_eSign::BulkSendRequest.new(envelopeOrTemplateId: envelope_id)
     batch = bulk_envelopes_api.create_bulk_send_request(args[:account_id], bulk_list_id, bulk_send_request)
     batch_id = batch.batch_id
+    # Step 7 end
 
-    # Step 8. Confirm successful batch send
+    # Confirm successful batch send
+    # Step 8 start
     bulk_envelopes_api.get_bulk_send_batch_status(args[:account_id], batch_id)
+    # Step 8 end
   end
 
   private
@@ -71,6 +84,7 @@ def construct_api_headers(api_client)
     api_client.default_headers['Accept-Language'] = "en-US,en;q=0.9"
   end
 
+  # Step 3-2 start
   def create_bulk_sending_list
     bulk_copies = []
     recipient1 = DocuSign_eSign::BulkSendingCopyRecipient.new(
@@ -119,7 +133,9 @@ def create_bulk_sending_list
     )
     bulk_sending_list
   end
+  # Step 3-2 end
 
+  # Step 5-2 start
   def custom_fields(bulk_list_id)
     text_custom_fields = DocuSign_eSign::TextCustomField.new(
       name:'mailingListId',
@@ -132,7 +148,9 @@ def custom_fields(bulk_list_id)
       textCustomFields: [text_custom_fields]
     )
   end
+  # Step 5-2 end
 
+  # Step 6-2 start
   def recipients_data
     signer = DocuSign_eSign::Signer.new(
       name: "Multi Bulk Recipient::signer",
@@ -147,33 +165,23 @@ def recipients_data
       recipientType: "signer"
     )
 
-    cc = DocuSign_eSign::Signer.new(
+    cc = DocuSign_eSign::CarbonCopy.new(
       name: "Multi Bulk Recipient::cc",
       email: "multiBulkRecipients-cc@docusign.com",
       roleName: "cc",
       note: "",
       routingOrder: 1,
       status: "created",
-      templateAccessCodeRequired: "null",
       deliveryMethod: "email",
       recipientId: "2",
-      recipientType: "signer"
+      recipientType: "cc"
     )
-    # The DocuSign platform searches throughout your envelope's documents for matching
-    # anchor strings. So the sign_here_2 tab will be used in both document 2 and 3
-    # since they use the same anchor string for their "signer 1" tabs.
-    sign_here = DocuSign_eSign::SignHere.new
-    sign_here.anchor_string = '/sn1/'
-    sign_here.anchor_units = 'pixels'
-    sign_here.anchor_x_offset = '20'
-    sign_here.anchor_y_offset = '10'
-    # Tabs are set per recipient/signer
-    tabs = DocuSign_eSign::Tabs.new
-    tabs.sign_here_tabs = [sign_here]
-    signer.tabs = tabs
+
     [signer, cc]
   end
+  # Step 6-2 end
 
+  # Step 4-2 start
   def make_envelope
     # Create the envelope definition
     envelope_definition = DocuSign_eSign::EnvelopeDefinition.new
@@ -199,18 +207,18 @@ def make_envelope
       recipientType: "signer"
     )
 
-    cc = DocuSign_eSign::Signer.new(
+    cc = DocuSign_eSign::CarbonCopy.new(
       name: "Multi Bulk Recipient::cc",
       email: "multiBulkRecipients-cc@docusign.com",
       roleName: "cc",
       note: "",
       routingOrder: 1,
       status: "created",
-      templateAccessCodeRequired: "null",
       deliveryMethod: "email",
       recipientId: "2",
-      recipientType: "signer"
+      recipientType: "cc"
     )
+
     # The DocuSign platform searches throughout your envelope's documents for matching
     # anchor strings. So the sign_here_2 tab will be used in both document 2 and 3
     # since they use the same anchor string for their "signer 1" tabs.
@@ -223,9 +231,12 @@ def make_envelope
     tabs = DocuSign_eSign::Tabs.new
     tabs.sign_here_tabs = [sign_here]
     signer.tabs = tabs
+
     # Add the recipients to the envelope object
-    recipients = DocuSign_eSign::Recipients.new
-    recipients.signers = [signer, cc]
+    recipients = DocuSign_eSign::Recipients.new(
+      signers: [signer],
+      carbonCopies: [cc]
+    )
 
     envelope_definition.recipients = recipients
     # The order in the docs array determines the order in the envelope
@@ -234,5 +245,6 @@ def make_envelope
     envelope_definition.status = "created"
     envelope_definition
   end
+  # Step 4-2 end
 
 end

app/views/e_sign/eg031_bulk_sending_envelopes/get.html.erb

@@ -1,13 +1,13 @@
 <h4>31. Bulk sending envelopes to multiple recipients</h4>
 
 <p>
-  Method BulkSend:createBulkSendList creates a bulk list that you can to use an envelope to up 
+  Method BulkSend:createBulkSendList creates a bulk list that you can to use an envelope to up
   to 1,000 recipients at once.
 </p>
 
 <p>API method used:
   <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/create/">EnvelopeRecipients::create</a>,
-  <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>,  
+  <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>,
   <a target='_blank' href="https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/BulkEnvelopes/get">BulkEnvelopes::get</a>,
   <a target='_blank' href="https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeCustomFields/create">EnvelopeCustomFields::create</a>,
   <a target='_blank' href="https://support.docusign.com/en/guides/ndse-user-guide-create-a-bulk-send-recipient-list">BulkSend::createBulkSendList</a>,
@@ -24,13 +24,12 @@
     <div class="form-group">
       <label for="signerEmail">Signer Email</label>
       <input type="email" class="form-control" id="signerEmail" name="signerEmail"
-             aria-describedby="emailHelp" placeholder="pat@example.com" required
-             value="<%= @config.signer_email %>">
+             aria-describedby="emailHelp" placeholder="pat@example.com" required>
     </div>
     <div class="form-group">
       <label for="signerName">Signer Name</label>
       <input type="text" class="form-control" id="signerName" placeholder="Pat Johnson" name="signerName"
-             value="<%= @config.signer_name %>" required>
+             required>
     </div>
   </div>
   <div class="your-class">
@@ -51,13 +50,12 @@
     <div class="form-group">
       <label for="signerEmail1">Signer Email</label>
       <input type="email" class="form-control" id="signerEmail1" name="signerEmail1"
-             aria-describedby="emailHelp" placeholder="pat@example.com" required
-             value="<%= @config.signer_email %>">
+             aria-describedby="emailHelp" placeholder="pat@example.com" required>
     </div>
     <div class="form-group">
       <label for="signerName1">Signer Name</label>
       <input type="text" class="form-control" id="signerName1" placeholder="Pat Johnson" name="signerName1"
-             value="<%= @config.signer_name %>" required>
+             required>
     </div>
   </div>
   <div class="your-class">
@@ -73,4 +71,4 @@
     </div>
   </div>
   <button type="submit" class="btn btn-docu">Submit</button>
-</form> 
+</form>