Devdocs 6974 (#61)

update sms delivery

Author: karissarjacobsen

app/controllers/e_sign/eg037_sms_delivery_controller.rb

@@ -6,9 +6,7 @@ class ESign::Eg037SmsDeliveryController < EgController
   def create
     begin
       envelope_args = {
-        signer_email: param_gsub(params['signer_email']),
         signer_name: param_gsub(params['signer_name']),
-        cc_email: param_gsub(params['cc_email']),
         cc_name: param_gsub(params['cc_name']),
         cc_phone_number: param_gsub(params['cc_phone_number']),
         cc_country_code: param_gsub(params['cc_country_code']),
@@ -25,8 +23,8 @@ def create
 
       results = ESign::Eg037SmsDeliveryService.new(args).worker
       session[:envelope_id] = results['envelope_id']
-      @title = 'Envelope sent'
-      @h1 = 'Envelope sent'
+      @title = 'Request a signature by SMS delivery'
+      @h1 = 'Request a signature by SMS delivery'
       @message = "The envelope has been created and sent!<br/>Envelope ID #{results['envelope_id']}."
       render 'ds_common/example_done'
     rescue DocuSign_eSign::ApiError => e

app/services/e_sign/eg037_sms_delivery_service.rb

@@ -12,18 +12,19 @@ def worker
     # Create the envelope request object
     envelope_definition = make_envelope(args[:envelope_args])
 
-    # Step 3. Create and send the envelope
+    # Create and send the envelope
     # Call Envelopes::create API method
     # Exceptions will be caught by the calling function
     envelope_api = create_envelope_api(args)
-
+    # Step 3 start
     results = envelope_api.create_envelope args[:account_id], envelope_definition
+    # Step 3 end
     envelope_id = results.envelope_id
     { 'envelope_id' => envelope_id }
   end
 
   private
-
+  # Step 2 start
   def make_envelope(envelope_args)
     # document 1 (HTML) has tag **signature_1**
     # document 2 (DOCX) has tag /sn1/
@@ -35,7 +36,7 @@ def make_envelope(envelope_args)
     # The envelope will be sent first to the signer via SMS
     # After it is signed, a copy is sent to the cc person via SMS
 
-    # Step 2. Create the envelope definition
+    # Create the envelope definition
     envelope_definition = DocuSign_eSign::EnvelopeDefinition.new
 
     envelope_definition.email_subject = 'Please sign this document set'
@@ -75,43 +76,31 @@ def make_envelope(envelope_args)
     # The order in the docs array determines the order in the envelope
     envelope_definition.documents = [document1, document2, document3]
 
-    phone_number = DocuSign_eSign::RecipientPhoneNumber.new
-    phone_number.country_code=envelope_args[:country_code]
-    phone_number.number=envelope_args[:phone_number]
-
-    sms_notification = DocuSign_eSign::RecipientAdditionalNotification.new
-    sms_notification.phone_number = phone_number
-    sms_notification.secondary_delivery_method = "SMS"
+    signer_phone_number = DocuSign_eSign::RecipientPhoneNumber.new
+    signer_phone_number.country_code=envelope_args[:country_code]
+    signer_phone_number.number=envelope_args[:phone_number]
 
     # Create the signer recipient model
     signer1 = DocuSign_eSign::Signer.new
-    signer1.additional_notifications=[sms_notification]
-    signer1.email = envelope_args[:signer_email]
+    signer1.phone_number = signer_phone_number
     signer1.name = envelope_args[:signer_name]
     signer1.recipient_id = '1'
     signer1.routing_order = '1'
     ## routingOrder (lower means earlier) determines the order of deliveries
     # to the recipients. Parallel routing order is supported by using the
     # same integer as the order for two or more recipients
 
-    # Create a RecipientPhoneNumber and add it to the additional SMS notification
     cc_phone_number = DocuSign_eSign::RecipientPhoneNumber.new
     cc_phone_number.country_code=envelope_args[:cc_country_code]
     cc_phone_number.number=envelope_args[:cc_phone_number]
 
-
-    cc_sms_notification = DocuSign_eSign::RecipientAdditionalNotification.new
-    cc_sms_notification.phone_number=cc_phone_number
-    cc_sms_notification.secondary_delivery_method = "SMS"
-
     # Create a cc recipient to receive a copy of the documents
-    cc1 = DocuSign_eSign::CarbonCopy.new(
-      email: envelope_args[:cc_email],
-      name: envelope_args[:cc_name],
-      routingOrder: '2',
-      recipientId: '2',
-      additionalNotifications: [cc_sms_notification]
-    )
+    cc1 = DocuSign_eSign::CarbonCopy.new
+    cc1.name = envelope_args[:cc_name]
+    cc1.routing_order = '2'
+    cc1.recipient_id = '2'
+    cc1.phone_number = cc_phone_number
+
     # Create signHere fields (also known as tabs) on the documents
     # We're using anchor (autoPlace) positioning
     #
@@ -165,8 +154,8 @@ def create_document1(args)
 margin-top: 0px;margin-bottom: 3.5em;font-size: 1em;
 color: darkblue;\">Order Processing Division</h2>
         <h4>Ordered by #{args[:signer_name]}</h4>
-        <p style=\"margin-top:0em; margin-bottom:0em;\">Email: #{args[:signer_email]}</p>
-        <p style=\"margin-top:0em; margin-bottom:0em;\">Copy to: #{args[:cc_name]}, #{args[:cc_email]}</p>
+        <p style=\"margin-top:0em; margin-bottom:0em;\">Phone number: #{args[:phone_number]}</p>
+        <p style=\"margin-top:0em; margin-bottom:0em;\">Copy to: #{args[:cc_name]}, #{args[:cc_phone_number]}</p>
         <p style=\"margin-top:3em;\">
   Candy bonbon pastry jujubes lollipop wafer biscuit biscuit. Topping brownie sesame snaps sweet roll pie. Croissant danish biscuit soufflé caramels jujubes jelly. Dragée danish caramels lemon drops dragée. Gummi bears cupcake biscuit tiramisu sugar plum pastry. Dragée gummies applicake pudding liquorice. Donut jujubes oat cake jelly-o. Dessert bear claw chocolate cake gummies lollipop sugar plum ice cream gummies cheesecake.
         </p>
@@ -175,4 +164,5 @@ def create_document1(args)
         </body>
     </html>"
   end
-end
+  # Step 2 end
+end

app/views/ds_common/index.html.erb

@@ -309,9 +309,9 @@
 
       <h2>Premium features</h2>
 
-      <h4 id="example037">37. <a href="eg037">Send an envelope by SMS delivery</a></h4>
+      <h4 id="example037">37. <a href="eg037">Request a signature by SMS delivery</a></h4>
       <p>
-        This example demonstrates how to send an envelope via an SMS message for a signer (and CC) to read and sign.
+        Sends a signature request via an SMS message.
       </p>
       <p>
         API method used:

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

@@ -1,11 +1,10 @@
-<h4>37. Send an envelope via SMS delivery</h4>
-
+<h4>37. Request a signature by SMS delivery</h4>
 <p>
-This is a general example of creating and sending an envelope (a signing request) to a recipient and notifying that recipient via SMS delivery.
+Sends a signature request via an SMS message.
 </p>
 
 <p>API method used:
-  <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>.
 </p>
 
 <p>
@@ -16,49 +15,36 @@ This is a general example of creating and sending an envelope (a signing request
   <div class="form-group">
     <label for="country_code">Signer Country Code</label>
     <input type="tel" class="form-control" id="country_code" name="country_code"
-      aria-describedby="accessHelp" placeholder="1" required
+      aria-describedby="accessHelp" placeholder="1" required />
     <small id="accessHelp" class="form-text text-muted">The country code for the phone number below.</small>
   </div>
   <div class="form-group">
     <label for="phone_number">Signer Phone Number</label>
     <input type="tel" class="form-control" id="phone_number" name="phone_number"
-      aria-describedby="accessHelp" placeholder="415-555-1212" required
-    <small id="accessHelp" class="form-text text-muted">This phone number will receive a notification. We'll never share your phone number with anyone else.</small>
-  </div>
-  <div class="form-group">
-    <label for="signer_email">Signer Email</label>
-    <input type="email" class="form-control" id="signer_email" name="signer_email"
-      aria-describedby="emailHelp" placeholder="pat@example.com" required
-      value="<%= @config.signer_email %>">
-    <small id="emailHelp" class="form-text text-muted">We'll never share your email with anyone else.</small>
+      aria-describedby="accessHelp" placeholder="415-555-1212" required />
+    <small id="accessHelp" class="form-text text-muted">This phone number will receive a notification. We'll never share your phone number.</small>
   </div>
   <div class="form-group">
     <label for="signer_name">Signer Name</label>
     <input type="text" class="form-control" id="signer_name" placeholder="Pat Johnson" name="signer_name"
-    value="<%= @config.signer_name %>" required>
+    value="<%= @config.signer_name %>" required />
   </div>
   <div class="form-group">
     <label for="country_code">CC Country Code</label>
     <input type="tel" class="form-control" id="cc_country_code" name="cc_country_code"
-      aria-describedby="accessHelp" placeholder="1" required
+      aria-describedby="accessHelp" placeholder="1" required />
     <small id="accessHelp" class="form-text text-muted">The country code for the phone number below.</small>
   </div>
   <div class="form-group">
     <label for="phone_number">CC Phone Number</label>
     <input type="tel" class="form-control" id="cc_phone_number" name="cc_phone_number"
-      aria-describedby="accessHelp" placeholder="415-555-1212" required
-    <small id="accessHelp" class="form-text text-muted">This phone number will receive a notification. We'll never share your phone number with anyone else.</small>
-  </div>
-  <div class="form-group">
-    <label for="cc_email">CC Email</label>
-    <input type="email" class="form-control" id="cc_email" name="cc_email"
-      aria-describedby="emailHelp" placeholder="pat@example.com" required />
-    <small id="emailHelp" class="form-text text-muted">The email for the cc recipient must be different from the signer's email.</small>
+      aria-describedby="accessHelp" placeholder="415-555-1212" required />
+    <small id="accessHelp" class="form-text text-muted">This phone number will receive a notification. We'll never share your phone number.</small>
   </div>
   <div class="form-group">
     <label for="cc_name">CC Name</label>
     <input type="text" class="form-control" id="cc_name" placeholder="Pat Johnson" name="cc_name"
       required />
   </div>
   <button type="submit" class="btn btn-docu">Submit</button>
-</form>
+</form>