|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +class Webforms::Eg001CreateInstanceService |
| 4 | + attr_reader :args |
| 5 | + |
| 6 | + include ApiCreator |
| 7 | + |
| 8 | + def initialize(args) |
| 9 | + @args = args |
| 10 | + end |
| 11 | + |
| 12 | + def create_web_form_template |
| 13 | + templates_api = create_template_api args |
| 14 | + |
| 15 | + options = DocuSign_eSign::ListTemplatesOptions.new |
| 16 | + options.search_text = args[:template_name] |
| 17 | + web_forms_templates = templates_api.list_templates(args[:account_id], options) |
| 18 | + |
| 19 | + if web_forms_templates.result_set_size.to_i.positive? |
| 20 | + template_id = web_forms_templates.envelope_templates[0].template_id |
| 21 | + else |
| 22 | + template_req_object = make_web_forms_template |
| 23 | + template = templates_api.create_template(args[:account_id], template_req_object) |
| 24 | + template_id = template.template_id |
| 25 | + end |
| 26 | + |
| 27 | + template_id |
| 28 | + end |
| 29 | + |
| 30 | + def list_web_forms |
| 31 | + configuration = DocuSign_WebForms::Configuration.new |
| 32 | + |
| 33 | + api_client = DocuSign_WebForms::ApiClient.new(configuration) |
| 34 | + api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}") |
| 35 | + |
| 36 | + webforms_api = DocuSign_WebForms::FormManagementApi.new(api_client) |
| 37 | + |
| 38 | + options = DocuSign_WebForms::ListFormsOptions.new |
| 39 | + options.search = args[:form_name] |
| 40 | + |
| 41 | + webforms_api.list_forms(args[:account_id], options) |
| 42 | + end |
| 43 | + |
| 44 | + def create_web_form_instance(form_id) |
| 45 | + configuration = DocuSign_WebForms::Configuration.new |
| 46 | + |
| 47 | + api_client = DocuSign_WebForms::ApiClient.new(configuration) |
| 48 | + api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}") |
| 49 | + |
| 50 | + webforms_api = DocuSign_WebForms::FormInstanceManagementApi.new(api_client) |
| 51 | + |
| 52 | + web_form_values = { |
| 53 | + 'PhoneNumber' => '555-555-5555', |
| 54 | + 'Yes' => ['Yes'], |
| 55 | + 'Company' => 'Tally', |
| 56 | + 'JobTitle' => 'Programmer Writer' |
| 57 | + } |
| 58 | + web_form_req_object = DocuSign_WebForms::CreateInstanceRequestBody.new({ |
| 59 | + 'clientUserId' => args[:client_user_id], |
| 60 | + 'formValues' => web_form_values, |
| 61 | + 'expirationOffset' => '3600' |
| 62 | + }) |
| 63 | + webforms_api.create_instance(args[:account_id], form_id, web_form_req_object) |
| 64 | + end |
| 65 | + |
| 66 | + private |
| 67 | + |
| 68 | + def make_web_forms_template |
| 69 | + template_name = args[:template_name] |
| 70 | + doc_file = 'World_Wide_Corp_Web_Form.pdf' |
| 71 | + base64_file_content = Base64.encode64(File.binread(File.join('data', doc_file))) |
| 72 | + |
| 73 | + # Create the document model |
| 74 | + document = DocuSign_eSign::Document.new({ |
| 75 | + # Create the DocuSign document object |
| 76 | + 'documentBase64' => base64_file_content, |
| 77 | + 'name' => 'World_Wide_Web_Form', # Can be different from actual file name |
| 78 | + 'fileExtension' => 'pdf', # Many different document types are accepted |
| 79 | + 'documentId' => '1' # A label used to reference the doc |
| 80 | + }) |
| 81 | + |
| 82 | + # Create the signer recipient model |
| 83 | + # Since these are role definitions, no name/email: |
| 84 | + signer = DocuSign_eSign::Signer.new({ |
| 85 | + 'roleName' => 'signer', 'recipientId' => '1', 'routingOrder' => '1' |
| 86 | + }) |
| 87 | + # Create fields using absolute positioning |
| 88 | + # Create a sign_here tab (field on the document) |
| 89 | + sign_here = DocuSign_eSign::SignHere.new( |
| 90 | + 'documentId' => '1', 'tabLabel' => 'Signature', |
| 91 | + 'anchorString' => '/SignHere/', 'anchorUnits' => 'pixel', |
| 92 | + 'anchorXOffset' => '20', 'anchorYOffset' => '10' |
| 93 | + ) |
| 94 | + check = DocuSign_eSign::Checkbox.new( |
| 95 | + 'documentId' => '1', 'tabLabel' => 'Yes', |
| 96 | + 'anchorString' => '/SMS/', 'anchorUnits' => 'pixel', |
| 97 | + 'anchorXOffset' => '20', 'anchorYOffset' => '10' |
| 98 | + ) |
| 99 | + text1 = DocuSign_eSign::Text.new( |
| 100 | + 'documentId' => '1', 'tabLabel' => 'FullName', |
| 101 | + 'anchorString' => '/FullName/', 'anchorUnits' => 'pixel', |
| 102 | + 'anchorXOffset' => '20', 'anchorYOffset' => '10' |
| 103 | + ) |
| 104 | + text2 = DocuSign_eSign::Text.new( |
| 105 | + 'documentId' => '1', 'tabLabel' => 'PhoneNumber', |
| 106 | + 'anchorString' => '/PhoneNumber/', 'anchorUnits' => 'pixel', |
| 107 | + 'anchorXOffset' => '20', 'anchorYOffset' => '10' |
| 108 | + ) |
| 109 | + text3 = DocuSign_eSign::Text.new( |
| 110 | + 'documentId' => '1', 'tabLabel' => 'Company', |
| 111 | + 'anchorString' => '/Company/', 'anchorUnits' => 'pixel', |
| 112 | + 'anchorXOffset' => '20', 'anchorYOffset' => '10' |
| 113 | + ) |
| 114 | + text4 = DocuSign_eSign::Text.new( |
| 115 | + 'documentId' => '1', 'tabLabel' => 'JobTitle', |
| 116 | + 'anchorString' => '/JobTitle/', 'anchorUnits' => 'pixel', |
| 117 | + 'anchorXOffset' => '20', 'anchorYOffset' => '10' |
| 118 | + ) |
| 119 | + date_signed = DocuSign_eSign::DateSigned.new( |
| 120 | + 'documentId' => '1', 'tabLabel' => 'DateSigned', |
| 121 | + 'anchorString' => '/Date/', 'anchorUnits' => 'pixel', |
| 122 | + 'anchorXOffset' => '20', 'anchorYOffset' => '10' |
| 123 | + ) |
| 124 | + |
| 125 | + # Add the tabs model to the signer |
| 126 | + # The Tabs object takes arrays of the different field/tab types |
| 127 | + signer.tabs = DocuSign_eSign::Tabs.new( |
| 128 | + 'signHereTabs' => [sign_here], |
| 129 | + 'checkboxTabs' => [check], |
| 130 | + 'textTabs' => [text1, text2, text3, text4], |
| 131 | + 'dateSignedTabs' => [date_signed] |
| 132 | + ) |
| 133 | + # Create top two objects |
| 134 | + envelope_template_definition = DocuSign_eSign::EnvelopeTemplate.new( |
| 135 | + 'description' => 'Example template created via the API', |
| 136 | + 'shared' => 'false' |
| 137 | + ) |
| 138 | + |
| 139 | + # Top object: |
| 140 | + DocuSign_eSign::EnvelopeTemplate.new( |
| 141 | + 'documents' => [document], |
| 142 | + 'name' => template_name, |
| 143 | + 'emailSubject' => 'Please sign this document', |
| 144 | + 'envelopeTemplateDefinition' => envelope_template_definition, |
| 145 | + 'recipients' => DocuSign_eSign::Recipients.new( |
| 146 | + 'signers' => [signer] |
| 147 | + ), |
| 148 | + 'status' => 'created' |
| 149 | + ) |
| 150 | + end |
| 151 | +end |
0 commit comments