diff --git a/.factorypath b/.factorypath deleted file mode 100644 index b4510fae..00000000 --- a/.factorypath +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml new file mode 100644 index 00000000..763ecc10 --- /dev/null +++ b/.github/workflows/maven.yml @@ -0,0 +1,39 @@ +name: Java launcher + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Set up JDK 11 + uses: actions/setup-java@v3 + with: + java-version: '11' + distribution: 'temurin' + cache: maven + - name: Check code with linters + run: mvn -U checkstyle:check + - name: Download dependancies + env: + CLIENT_ID: ${{ secrets.CLIENT_ID }} + IMPERSONATED_USER_ID: ${{ secrets.IMPERSONATED_USER_ID }} + PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }} + SIGNER_EMAIL: ${{ secrets.SIGNER_EMAIL }} + SIGNER_NAME: ${{ secrets.SIGNER_NAME }} + run: mvn install + - name: Build with Maven + env: + CLIENT_ID: ${{ secrets.CLIENT_ID }} + IMPERSONATED_USER_ID: ${{ secrets.IMPERSONATED_USER_ID }} + PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }} + SIGNER_EMAIL: ${{ secrets.SIGNER_EMAIL }} + SIGNER_NAME: ${{ secrets.SIGNER_NAME }} + run: mvn -B package --file pom.xml diff --git a/.gitignore b/.gitignore index 23e56e0d..73ec87e5 100644 --- a/.gitignore +++ b/.gitignore @@ -38,3 +38,16 @@ hs_err_pid* private.key application.properties +/target/ +src/main/resources/application.json +src/main/resources/application.properties +src/main/java/com/docusign/admin/ + +# according to gitignore.io this shouldnt be shared +.factorypath +src/main/resources/ExportedUserData.csv +app.config +Quick_ACG/target/* +JWT Console App/target/* +Quick_ACG/src/main/resources/application.json + diff --git a/.metadata/.plugins/org.eclipse.epp.logging.aeri.ide/org.eclipse.epp.logging.aeri.ide.server/server-config.json b/.metadata/.plugins/org.eclipse.epp.logging.aeri.ide/org.eclipse.epp.logging.aeri.ide.server/server-config.json index 867c06cd..879f1b33 100644 --- a/.metadata/.plugins/org.eclipse.epp.logging.aeri.ide/org.eclipse.epp.logging.aeri.ide.server/server-config.json +++ b/.metadata/.plugins/org.eclipse.epp.logging.aeri.ide/org.eclipse.epp.logging.aeri.ide.server/server-config.json @@ -33,7 +33,7 @@ "com.sun.*", "java.*", "javafx.*", - "javax.*", + "jakarta.*", "org.apache.*", "org.eclipse.*", "org.fordiac.*", diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 00000000..6fcb152c --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,21 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "type": "java", + "name": "Launch App", + "request": "launch", + "mainClass": "com.docusign.App", + "projectName": "code-examples-java" + }, + { + "type": "java", + "name": "Launch Java Program", + "request": "launch", + "mainClass": "" + } + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index e0f15db2..0be1c0c6 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,3 +1,4 @@ { - "java.configuration.updateBuildConfiguration": "automatic" + "java.configuration.updateBuildConfiguration": "automatic", + "java.compile.nullAnalysis.mode": "automatic" } \ No newline at end of file diff --git a/JWT Console App/app.config.example b/JWT Console App/app.config.example new file mode 100644 index 00000000..25f4225d --- /dev/null +++ b/JWT Console App/app.config.example @@ -0,0 +1,3 @@ +clientId={INTEGRATION_KEY_JWT} +userId={IMPERSONATED_USER_ID} +rsaKeyFile=private.key \ No newline at end of file diff --git a/JWT Console App/pom.xml b/JWT Console App/pom.xml new file mode 100644 index 00000000..53e5921f --- /dev/null +++ b/JWT Console App/pom.xml @@ -0,0 +1,81 @@ + + + 4.0.0 + + docusign.jwtconsoleapp + code-examples-java-JWT + 1.0-SNAPSHOT + + DocuSign Java JWT Console App + + + UTF-8 + 11 + 11 + 4.0.0-RC1 + + + + + + commons-cli + commons-cli + 1.5.0 + + + + org.apache.commons + commons-math3 + 3.6.1 + + + + com.docusign + docusign-esign-java + ${esignature.version} + shaded + + + + commons-io + commons-io + 2.11.0 + + + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.9.0 + + 11 + 11 + + + + + org.apache.maven.plugins + maven-jar-plugin + 3.2.1 + + + + true + lib/ + com.docusign.jwtconsoleapp.JWTConsoleApp + + + + + + + + \ No newline at end of file diff --git a/JWT Console App/src/main/java/com/docusign/JWTConsoleApp.java b/JWT Console App/src/main/java/com/docusign/JWTConsoleApp.java new file mode 100644 index 00000000..7f8f0f4b --- /dev/null +++ b/JWT Console App/src/main/java/com/docusign/JWTConsoleApp.java @@ -0,0 +1,146 @@ +package com.docusign.jwtconsoleapp; + +import org.apache.commons.cli.CommandLine; +import org.apache.commons.cli.CommandLineParser; +import org.apache.commons.cli.DefaultParser; +import org.apache.commons.cli.HelpFormatter; +import org.apache.commons.cli.Options; +import org.apache.commons.cli.ParseException; + +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.auth.OAuth; +import com.docusign.esign.client.auth.OAuth.OAuthToken; +import com.docusign.esign.client.auth.OAuth.UserInfo; +import com.docusign.esign.client.auth.OAuth.Account; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.Document; +import com.docusign.esign.model.CarbonCopy; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.Recipients; +import com.docusign.esign.model.Signer; +import com.docusign.esign.model.Tabs; +import com.docusign.esign.model.SignHere; + +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.*; +import java.io.*; +import java.awt.Desktop; +import java.net.URI; + +/** + * Starter class for JWTConsoleApp application. + */ + +public class JWTConsoleApp { + + static String DevCenterPage = "https://developers.docusign.com/platform/auth/consent"; + /** + * Application entry point. + * + * @param args application command line arguments + */ + public static void main(String[] args) throws java.io.IOException { + + Scanner scanner = new Scanner(System. in); + System.out.println ("Welcome to the JWT Code example! "); + System.out.print("Enter the signer's email address: "); + String signerEmail = scanner. nextLine(); + System.out.print("Enter the signer's name: "); + String signerName = scanner. nextLine(); + System.out.print("Enter the carbon copy's email address: "); + String ccEmail = scanner. nextLine(); + System.out.print("Enter the carbon copy's name: "); + String ccName = scanner. nextLine(); + + // Get information fro app.config + Properties prop = new Properties(); + String fileName = "app.config"; + FileInputStream fis = new FileInputStream(fileName); + prop.load(fis); + try + { + // Get access token and accountId + ApiClient apiClient = new ApiClient("https://demo.docusign.net/restapi"); + apiClient.setOAuthBasePath("account-d.docusign.com"); + ArrayList scopes = new ArrayList(); + scopes.add("signature"); + scopes.add("impersonation"); + byte[] privateKeyBytes = Files.readAllBytes(Paths.get(prop.getProperty("rsaKeyFile"))); + OAuthToken oAuthToken = apiClient.requestJWTUserToken( + prop.getProperty("clientId"), + prop.getProperty("userId"), + scopes, + privateKeyBytes, + 3600); + String accessToken = oAuthToken.getAccessToken(); + UserInfo userInfo = apiClient.getUserInfo(accessToken); + String accountId = userInfo.getAccounts().get(0).getAccountId(); + + // Create envelopeDefinition object + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("Please sign this document set"); + envelope.setStatus("sent"); + + // Create tabs object + SignHere signHere = new SignHere(); + signHere.setDocumentId("1"); + signHere.setPageNumber("1"); + signHere.setXPosition("191"); + signHere.setYPosition("148"); + Tabs tabs = new Tabs(); + tabs.setSignHereTabs(Arrays.asList(signHere)); + // Set recipients + Signer signer = new Signer(); + signer.setEmail(signerEmail); + signer.setName(signerName); + signer.recipientId("1"); + signer.setTabs(tabs); + CarbonCopy cc = new CarbonCopy(); + cc.setEmail(ccEmail); + cc.setName(ccName); + cc.recipientId("2"); + Recipients recipients = new Recipients(); + recipients.setSigners(Arrays.asList(signer)); + recipients.setCarbonCopies(Arrays.asList(cc)); + envelope.setRecipients(recipients); + + // Add document + Document document = new Document(); + document.setDocumentBase64("VGhhbmtzIGZvciByZXZpZXdpbmcgdGhpcyEKCldlJ2xsIG1vdmUgZm9yd2FyZCBhcyBzb29uIGFzIHdlIGhlYXIgYmFjay4="); + document.setName("doc1.txt"); + document.setFileExtension("txt"); + document.setDocumentId("1"); + envelope.setDocuments(Arrays.asList(document)); + + // Send envelope + apiClient.addDefaultHeader("Authorization", "Bearer " + accessToken); + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + EnvelopeSummary results = envelopesApi.createEnvelope(accountId, envelope); + System.out.println("Successfully sent envelope with envelopeId " + results.getEnvelopeId()); + } + catch (ApiException exp) + { + if (exp.getMessage().contains("consent_required")) + { + try + { + System.out.println ("Consent required, please provide consent in browser window and then run this app again."); + Desktop.getDesktop().browse(new URI("https://account-d.docusign.com/oauth/auth?response_type=code&scope=impersonation%20signature&client_id=" + prop.getProperty("clientId") + "&redirect_uri=" + DevCenterPage)); + } + catch (Exception e) + { + System.out.print ("Error!!! "); + System.out.print (e.getMessage()); + } + } + } + catch (Exception e) + { + System.out.print ("Error!!! "); + System.out.print (e.getMessage()); + } + } +} \ No newline at end of file diff --git a/PAYMENTS_INSTALLATION.md b/PAYMENTS_INSTALLATION.md index 689be36d..d575c2c2 100644 --- a/PAYMENTS_INSTALLATION.md +++ b/PAYMENTS_INSTALLATION.md @@ -1,24 +1,21 @@ -# Configuring a DocuSign payments gateway +# Configure a payment gateway -DocuSign offers built-in connections to multiple payment -gateways. The payments example uses a demo account via the Stripe -gateway service. +DocuSign offers built-in connections to multiple payment gateways. The payments code example uses a developer account via the Stripe gateway service. -## Creating the payments gateway account -1. Login to demo.docusign.net and go to the Admin Tool. -1. On the Integrations / Payments screen, click Stripe. -1. For development, you can skip the Stripe account application - by using the `Skip this account form` link: +## Create a Stripe payment gateway + +1. Select the Stripe button on the [**Payments**](https://admindemo.docusign.com/authenticate?goTo=payments) page in your developer account. + +1. For development, you can skip the Stripe account application by using the **Skip this account form** link at the top of the page.
+ + ![Skipping the Stripe account form](docs/stripe_skip_account_form_link.png) + + An enabled Stripe payment gateway is now associated with your DocuSign developer account and is shown under **Payment Gateway**. + +1. Save the **Gateway Account ID** GUID to the code example launcher configuration file. - ![Skipping the Stripe account form](docs/stripe_skip_account_form_link.png) -1. Next, the Admin Tool will show that an enabled Stripe - payment gateway account has been associated with your - DocuSign demo sandbox account. -1. Configure the example launcher with the gateway account id shown in the Admin tool. ## Additional documentation -See the -[Managing Payment Gateways](https://support.docusign.com/en/guides/managing-payment-gateways) -documentation. - +* [Managing Payment Gateways](https://support.docusign.com/en/guides/managing-payment-gateways) +* [How to send a request for payment](https://developers.docusign.com/docs/esign-rest-api/how-to/request-a-payment) diff --git a/Quick_ACG/pom.xml b/Quick_ACG/pom.xml new file mode 100644 index 00000000..dba87162 --- /dev/null +++ b/Quick_ACG/pom.xml @@ -0,0 +1,274 @@ + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 2.5.12 + + + + com.docusign + code-examples-java-acg + 1.0-SNAPSHOT + + Docusign Java Tutorial + + + 11 + 2.5.6 + 2.11.0 + 3.17.1 + 1.1.0 + 1.0.0 + 1.0.0 + 1.0.0-BETA + 4.0.0-RC1 + + + + + org.springframework.boot + spring-boot-starter-security + + + org.springframework.boot + spring-boot-starter-web + + + + org.springframework.boot + spring-boot-starter-oauth2-client + + + + org.apache.commons + commons-lang3 + + + org.freemarker + freemarker + + + com.google.code.gson + gson + + + com.fasterxml.jackson.datatype + jackson-datatype-joda + + + + + javax.servlet + jstl + + + + org.apache.tomcat.embed + tomcat-embed-jasper + provided + + + + commons-io + commons-io + ${commonsio.version} + + + com.docusign + docusign-esign-java + ${esignature.version} + shaded + + + + com.docusign + docusign-rooms-java + ${rooms.version} + + + + com.docusign + docusign-click-java + ${click.version} + + + + com.docusign + docusign-monitor-java + ${monitor.version} + + + + com.docusign + docusign-admin-java + ${admin.version} + + + + org.projectlombok + lombok + RELEASE + compile + + + org.springframework.boot + spring-boot-autoconfigure + 2.5.15 + + + + + + + maven-resources-plugin + 3.2.0 + + + copy-resource-one + generate-sources + + copy-resources + + + ${basedir} + + + ${basedir}/src/main/resources + ../src/main/resources + + application.json + World_Wide_Corp_lorem.pdf + + + + ${basedir}/src/main/resources/META-INF + ../src/main/resources/META-INF + + spring.factories + + + + ${basedir}/src/main/resources/public/assets + ../src/main/resources/public/assets + + favicon.ico + css.css + + + + ${basedir}/src/main/java/com/docusign + ../src/main/java/com/docusign + + JsonPropertySourceLoader.java + OSDetector.java + EG001ControllerEmbeddedSigning.java + + + + ${basedir}/src/main/java/com/docusign/common + ../src/main/java/com/docusign/common + + WorkArguments.java + + + + ${basedir}/src/main/java/com/docusign/controller/eSignature/examples + ../src/main/java/com/docusign/controller/eSignature/examples + + EnvelopeHelpers.java + ExampleException.java + + + + ${basedir}/src/main/java/com/docusign/controller/eSignature/services + ../src/main/java/com/docusign/controller/eSignature/services + + EmbeddedSigningService.java + + + + ${basedir}/src/main/java/com/docusign/core/model + ../src/main/java/com/docusign/core/model + + Locals.java + User.java + + + + ${basedir}/src/main/java/com/docusign/core/common + ../src/main/java/com/docusign/core/common + + Utils.java + DiffField.java + + + + ${basedir}/src/main/java/com/docusign/core/utils + ../src/main/java/com/docusign/core/utils + + AccountsConverter.java + + + + ${basedir}/src/main/java/com/docusign/core/model/manifestModels + ../src/main/java/com/docusign/core/model/manifestModels + + AdditionalPage.java + APIs.java + CodeExampleText.java + CustomErrorTexts.java + Forms.java + HelpingTexts.java + Inputs.java + LinkToAPIMethods.java + LoginPage.java + ManifestGroup.java + ManifestStructure.java + RedirectsToOtherCodeExamples.java + SelectAPIPage.java + SupportingTexts.java + + + + ${basedir}/src/main/java/com/docusign/core/security + ../src/main/java/com/docusign/core/security + + OAuthProperties.java + + + + ${basedir}/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples + ../src/main/webapp/WEB-INF/templates/views/pages/esignature/examples + + quickEmbeddedSigning.jsp + + + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + true + + + + + + + + + org.bouncycastle + bcprov-jdk15on + 1.69 + + + + \ No newline at end of file diff --git a/Quick_ACG/src/main/java/com/docusign/App.java b/Quick_ACG/src/main/java/com/docusign/App.java new file mode 100644 index 00000000..ab51eaf1 --- /dev/null +++ b/Quick_ACG/src/main/java/com/docusign/App.java @@ -0,0 +1,59 @@ +package com.docusign; + +import java.io.IOException; +import java.net.URI; +import java.nio.file.FileSystemAlreadyExistsException; +import java.nio.file.FileSystems; +import java.util.Collections; +import java.util.Properties; + +import lombok.extern.slf4j.Slf4j; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration; + +@Slf4j +@SpringBootApplication(exclude={JmxAutoConfiguration.class}) +public class App { + + public static void main(String[] args) throws IOException { + SpringApplication.run(App.class, args); + openHomePage(); + initFileSystem(); + } + + private static void openHomePage() throws IOException { + // Each operating system opens web browsers differently so we need to determine the user's + // OS and open a browser to the example homepage accordingly. + Runtime rt = Runtime.getRuntime(); + if (OSDetector.isMac()){ + String[] arguments = { "osascript", "-e", "open location \"" + "http://localhost:8080" + "\"" }; + rt.exec(arguments); + } + else if (OSDetector.isWindows()){ + rt.exec("rundll32 url.dll,FileProtocolHandler " + "http://localhost:8080"); + } + else if (OSDetector.isLinux()){ + String [] browsers = {"firefox", "safari", "chrome", "mozilla"}; + StringBuffer cmd = new StringBuffer(); + for (int i=0; i= HttpURLConnection.HTTP_BAD_REQUEST) { + throw new Exception(httpConnection.getResponseMessage()); + } + + BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(httpConnection.getInputStream())); + StringBuilder stringBuilder = new StringBuilder(); + String temp; + while ((temp = bufferedReader.readLine()) != null) { + stringBuilder.append(temp); + } + bufferedReader.close(); + httpConnection.disconnect(); + + return stringBuilder.toString(); + } +} diff --git a/Quick_ACG/src/main/java/com/docusign/WebSecurityConfig.java b/Quick_ACG/src/main/java/com/docusign/WebSecurityConfig.java new file mode 100644 index 00000000..641ddd8c --- /dev/null +++ b/Quick_ACG/src/main/java/com/docusign/WebSecurityConfig.java @@ -0,0 +1,53 @@ +package com.docusign; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.annotation.Bean; +import org.springframework.security.config.Customizer; +import org.springframework.security.config.annotation.web.builders.HttpSecurity; +import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; +import org.springframework.security.web.SecurityFilterChain; +import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint; +import org.springframework.security.web.savedrequest.HttpSessionRequestCache; +import org.springframework.security.web.savedrequest.RequestCache; + +@EnableWebSecurity +public class WebSecurityConfig { + + @Autowired + public DSConfiguration dsConfiguration; + + @Bean + public RequestCache requestCache() { + return new HttpSessionRequestCache(); + } + + @Bean + public SecurityFilterChain filterChain(HttpSecurity http) throws Exception { + http + .authorizeHttpRequests(authorize -> { + try { + authorize + .antMatchers("/", "/error**", "/assets/**", "/ds/mustAuthenticate**", + "/ds/authenticate**", "/ds/selectApi**") + .permitAll() + .anyRequest().authenticated() + .and() + .exceptionHandling() + .authenticationEntryPoint( + new LoginUrlAuthenticationEntryPoint("/ds/mustAuthenticate") + ); + } catch (Exception e) { + throw new RuntimeException(e); + } + }) + .requestCache().requestCache(requestCache()).and() + .oauth2Login(Customizer.withDefaults()) + .oauth2Client(Customizer.withDefaults()) + .logout(logout -> logout + .logoutSuccessUrl("/") + ) + .csrf().disable(); + + return http.build(); + } +} diff --git a/Quick_ACG/src/main/java/com/docusign/controller/eSignature/examples/AbstractEsignatureController.java b/Quick_ACG/src/main/java/com/docusign/controller/eSignature/examples/AbstractEsignatureController.java new file mode 100644 index 00000000..4a5b3085 --- /dev/null +++ b/Quick_ACG/src/main/java/com/docusign/controller/eSignature/examples/AbstractEsignatureController.java @@ -0,0 +1,148 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.core.model.User; +import com.docusign.core.model.manifestModels.APIs; +import com.docusign.core.model.manifestModels.CodeExampleText; +import com.docusign.core.model.Session; +import com.docusign.core.model.manifestModels.ManifestGroup; +import com.docusign.esign.client.ApiClient; +import org.apache.commons.lang3.exception.ExceptionUtils; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpHeaders; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PostMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.List; +import java.util.Objects; +import java.util.Arrays; + +/** + * Abstract base class for all eSignature controllers. + */ +@Controller +public abstract class AbstractEsignatureController { + + protected static final String BEARER_AUTHENTICATION = "Bearer "; + + @Autowired + protected Session session; + + protected final String exampleName; + protected String title; + private final String pagePath; + protected final DSConfiguration config; + protected CodeExampleText codeExampleText; + private static final String EXAMPLE_PAGES_PATH = "pages/esignature/examples/"; + private static final String EXAMPLE_TEXT = "example"; + private static final String LAUNCHER_TEXTS = "launcherTexts"; + protected final User user; + + public AbstractEsignatureController(DSConfiguration config, String exampleName, Session session, User user) { + this.config = config; + this.session = session; + this.user = user; + this.exampleName = exampleName; + this.pagePath = this.getExamplePagesPath() + exampleName; + } + + protected String getExamplePagesPath() { + return AbstractEsignatureController.EXAMPLE_PAGES_PATH; + } + + /** + * Creates new instance of the eSignature API client. + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return an instance of the {@link ApiClient} + */ + protected static ApiClient createApiClient(String basePath, String userAccessToken) { + ApiClient apiClient = new ApiClient(basePath); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + userAccessToken); + return apiClient; + } + + @GetMapping + public String get(WorkArguments args, ModelMap model) { + try { + onInitModel(args, model); + return pagePath; + } catch (Exception exception) { + return handleException(exception, model); + } + } + + @PostMapping + public Object create(WorkArguments args, ModelMap model, HttpServletResponse response) { + try { + return doWork(args, model, response); + } catch (Exception exception) { + return handleException(exception, model); + } + } + + /** + * This method is called from the GET request and it should initialize a + * model. Override this method if it is necessary to add example specific + * attributes into the model. + * @param args + * @param model the model data + */ + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + this.codeExampleText = GetExampleText(); + this.title = this.codeExampleText.ExampleName; + + Class clazz = Objects.requireNonNullElse(getClass().getEnclosingClass(), getClass()); + String srcPath = String.join("", config.getExampleUrl(), clazz.getName().replace('.', '/'), ".java"); + model.addAttribute("csrfToken", ""); + model.addAttribute("title", title); + model.addAttribute("sourceFile", clazz.getSimpleName() + ".java"); + model.addAttribute("sourceUrl", srcPath); + model.addAttribute("documentation", config.getDocumentationPath() + exampleName); + model.addAttribute(EXAMPLE_TEXT, this.codeExampleText); + model.addAttribute(LAUNCHER_TEXTS, config.getCodeExamplesText().SupportingTexts); + } + + /** + * This method is called from the POST request. Example pages must override + * it. Overridden method should return an Object means URL to redirect. + * @param args the work arguments got from the current page + * @param model page model holder + * @param response for HTTP-specific functionality in sending a response + * @return {@link Object}. Possible types and values: null, + * {@link String} representation of the URL or Spring RedirectView object, + * (see {@link org.springframework.web.servlet.view.RedirectView RedirectView}) + * @throws Exception if calling API has failed or if I/O operation has failed + */ + protected abstract Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws Exception; + + private String handleException(Exception exception, ModelMap model) { + return ExceptionUtils.getStackTrace(exception); + } + + protected CodeExampleText GetExampleText() { + List eSignatureManifestGroups = config.getCodeExamplesText().APIs.stream() + .filter(x -> "esignature".contains(((APIs) x).Name.toLowerCase())) + .findFirst() + .orElse(null).Groups; + var exampleNumberToSearch = 1; + + for (ManifestGroup group : eSignatureManifestGroups) { + CodeExampleText codeExampleText = group.Examples.stream() + .filter(x -> ((CodeExampleText) x).ExampleNumber == exampleNumberToSearch) + .findFirst() + .orElse(null); + + if (codeExampleText != null) + { + return codeExampleText; + } + } + return null; + } +} diff --git a/Quick_ACG/src/main/java/com/docusign/core/controller/IndexController.java b/Quick_ACG/src/main/java/com/docusign/core/controller/IndexController.java new file mode 100644 index 00000000..38e128b5 --- /dev/null +++ b/Quick_ACG/src/main/java/com/docusign/core/controller/IndexController.java @@ -0,0 +1,189 @@ +package com.docusign.core.controller; + +import com.docusign.DSConfiguration; +import com.docusign.core.model.Locals; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import java.io.IOException; +import java.util.*; + +import com.docusign.core.utils.AccountsConverter; +import org.apache.commons.lang3.StringUtils; +import org.json.JSONObject; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.annotation.Scope; +import org.springframework.security.core.context.SecurityContextHolder; +import org.springframework.security.oauth2.client.OAuth2AuthorizedClient; +import org.springframework.security.oauth2.client.OAuth2AuthorizedClientService; +import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken; +import org.springframework.security.oauth2.core.user.OAuth2User; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.*; +import org.springframework.web.context.WebApplicationContext; +import org.springframework.web.servlet.ModelAndView; +import org.springframework.web.servlet.view.RedirectView; +import com.docusign.esign.client.auth.OAuth; +import java.util.stream.Collectors; +import org.springframework.security.core.Authentication; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.bind.annotation.ModelAttribute; +import javax.servlet.http.HttpServletResponse; + +@Controller +@ControllerAdvice +@Scope(WebApplicationContext.SCOPE_SESSION) +public class IndexController { + private static final String ATTR_ENVELOPE_ID = "qpEnvelopeId"; + private static final String ATTR_STATE = "state"; + private static final String ATTR_EVENT = "event"; + private static final String ATTR_TITLE = "title"; + + private static final String ERROR_ACCOUNT_NOT_FOUND = "Could not find account information for the user"; + private static final String SELECTED_API_NOT_SUPPORTED = "Currently selected api is not supported by launcher. Please, check appsettings.json file."; + private final DSConfiguration config; + private final Session session; + private final User user; + private Optional account; + + @Autowired + private OAuth2AuthorizedClientService authorizedClientService; + + @Autowired + public IndexController(DSConfiguration config, Session session, User user, Optional account) { + this.config = config; + this.session = session; + this.user = user; + this.account = account; + } + + @GetMapping(path = "/") + public String index(ModelMap model, HttpServletResponse response) throws IOException { + String site = "/eg001"; + response.setStatus(response.SC_MOVED_TEMPORARILY); + response.setHeader("Location", site); + return null; + } + + @GetMapping(path = "/ds/mustAuthenticate") + public ModelAndView mustAuthenticateController(ModelMap model) throws IOException { + return new ModelAndView(getRedirectView()); + } + + @GetMapping(path = "/ds-return") + public String returnController(@RequestParam(value = ATTR_STATE, required = false) String state, + @RequestParam(value = ATTR_EVENT, required = false) String event, + @RequestParam(value = "envelopeId", required = false) String envelopeId, ModelMap model, HttpServletResponse response) throws IOException { + String site = "/eg001"; + response.setStatus(response.SC_MOVED_TEMPORARILY); + response.setHeader("Location", site); + return null; + } + + private RedirectView getRedirectView() { + RedirectView redirect = new RedirectView(getLoginPath()); + redirect.setExposeModelAttributes(false); + return redirect; + } + + private String getLoginPath() { + return config.getAcgRedirectURL(); + } + + @ModelAttribute("documentOptions") + public List populateDocumentOptions() { + return new ArrayList<>(); + } + + @ModelAttribute("showDoc") + public boolean populateShowDoc() { + return StringUtils.isNotBlank(config.getDocumentationPath()); + } + + @ModelAttribute("locals") + public Object populateLocals() throws IOException { + Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); + + if (!(authentication instanceof OAuth2AuthenticationToken)) { + return new RedirectView("/"); + } + + OAuth2AuthenticationToken oauth = (OAuth2AuthenticationToken) authentication; + OAuth2User oauthUser = oauth.getPrincipal(); + OAuth2AuthorizedClient oauthClient = authorizedClientService.loadAuthorizedClient( + oauth.getAuthorizedClientRegistrationId(), + oauthUser.getName() + ); + + if (oauth.isAuthenticated()) { + user.setName(oauthUser.getAttribute("name")); + user.setAccessToken(oauthClient.getAccessToken().getTokenValue()); + + if (account.isEmpty()) { + account = Optional.ofNullable(getDefaultAccountInfo(getOAuthAccounts(oauthUser))); + } + + OAuth.Account oauthAccount = account.orElseThrow(() -> new NoSuchElementException(ERROR_ACCOUNT_NOT_FOUND)); + session.setAccountId(oauthAccount.getAccountId()); + session.setAccountName(oauthAccount.getAccountName()); + // TODO set this more efficiently with more APIs as they're added in + String basePath = this.getBaseUrl(oauthAccount) + "/restapi"; + session.setBasePath(basePath); + } + + return new Locals(config, session, user, ""); + } + + private String getBaseUrl(OAuth.Account oauthAccount) { + return oauthAccount.getBaseUri(); + } + + private static List getOAuthAccounts(OAuth2User user) { + List> oauthAccounts = user.getAttribute("accounts"); + if(oauthAccounts == null){ + return new ArrayList<>(); + } + + return oauthAccounts.stream() + .map(AccountsConverter::convert) + .collect(Collectors.toList()); + } + + private OAuth.Account getDefaultAccountInfo(List accounts) { + String targetAccountId = config.getTargetAccountId(); + if (StringUtils.isNotBlank(targetAccountId)) { + OAuth.Account account = getAccountById(accounts, targetAccountId); + if(account != null) { + return account; + } + } + return getDefaultAccount(accounts); + } + + private static OAuth.Account getDefaultAccount(List accounts) { + for (OAuth.Account oauthAccount : accounts) { + if ("true".equals(oauthAccount.getIsDefault())) { + return oauthAccount; + } + } + return null; + } + + private static OAuth.Account getAccountById(List accounts, String accountId) { + for (OAuth.Account oauthAccount : accounts) { + if (StringUtils.equals(oauthAccount.getAccountId(), accountId)) { + return oauthAccount; + } + } + return null; + } + + public static OAuth.Account convert(Map account) { + OAuth.Account res = new OAuth.Account(); + res.setAccountId((String) account.get("account_id")); + res.setIsDefault(String.valueOf(account.get("is_default"))); + res.setAccountName((String) account.get("account_name")); + res.setBaseUri((String) account.get("base_uri")); + return res; + } +} diff --git a/src/main/java/com/docusign/model/Session.java b/Quick_ACG/src/main/java/com/docusign/core/model/Session.java similarity index 68% rename from src/main/java/com/docusign/model/Session.java rename to Quick_ACG/src/main/java/com/docusign/core/model/Session.java index a68e730d..e37c07fb 100644 --- a/src/main/java/com/docusign/model/Session.java +++ b/Quick_ACG/src/main/java/com/docusign/core/model/Session.java @@ -1,15 +1,14 @@ -package com.docusign.model; +package com.docusign.core.model; import lombok.Data; - -import java.io.Serializable; -import java.util.List; - import org.springframework.context.annotation.Scope; import org.springframework.context.annotation.ScopedProxyMode; import org.springframework.stereotype.Component; import org.springframework.web.context.WebApplicationContext; +import java.io.Serializable; +import java.util.List; +import java.util.UUID; @Component @Scope(value = WebApplicationContext.SCOPE_SESSION, @@ -21,11 +20,19 @@ public class Session implements Serializable { private String accountId; private String accountName; private String basePath; + private String statusCFR; + private String roomsBasePath; private String envelopeId; + private String templateId; private String templateName; - private List envelopeDocuments; private String permissionProfileId; private String permissionProfileName; - private AuthType authTypeSelected = AuthType.AGC; + private String apiIndexPath; private boolean refreshToken = false; + private String clickwrapId; + private String clickwrapVersionNumber; + private String exportId; + private String importId; + private UUID orgId; + public UUID bulkListId; } diff --git a/Quick_ACG/src/main/resources/application.example.json b/Quick_ACG/src/main/resources/application.example.json new file mode 100644 index 00000000..6bb5d0e3 --- /dev/null +++ b/Quick_ACG/src/main/resources/application.example.json @@ -0,0 +1,41 @@ +{ + "quickstart" :"{QUICKSTART_VALUE}", + "quickACG": "{QUICK_ACG_VALUE}", + "DS_SIGNER_NAME": "{SIGNER_NAME}", + "DS_SIGNER_EMAIL": "{SIGNER_EMAIL}", + "DS_APP_URL": "http://localhost:8080", + "DS_TARGET_ACCOUNT_ID": "{IMPERSONATED_USER_ID}", + "DS_BASE_PATH": "https://demo.docusign.net", + "DS_ROOMS_BASE_PATH": "https://demo.rooms.docusign.com", + "DS_CLICK_BASE_PATH": "https://demo.docusign.net", + "DS_MONITOR_BASE_PATH": "https://lens-d.docusign.net", + "DS_ADMIN_BASE_PATH": "https://api-d.docusign.net", + + "Gateway_Name": "{DS_PAYMENT_GATEWAY_NAME}", + "Gateway_Account_Id": "{GATEWAY_ACCOUNT_ID}", + "Gateway_Display_Name": "{DS_PAYMENT_GATEWAY_DISPLAY_NAME}", + + "authorization.code.grant.client.scope": "signature", + "authorization.code.grant.sso.redirect-url": "&type=acg", + "authorization.code.grant.client.client-id": "{INTEGRATION_KEY_AUTH_CODE}", + "authorization.code.grant.client.client-secret": "{SECRET_KEY}", + "authorization.code.grant.client.access-token-uri": "https://account-d.docusign.com/oauth/token", + "authorization.code.grant.client.user-authorization-uri": "https://account-d.docusign.com/oauth/auth?prompt=login", + + "common.client.resource.user-info-uri": "https://account-d.docusign.com/oauth/userinfo", + "com.docusign.github.example-uri": "https://github.com/docusign/code-examples-java/blob/master/src/main/java/", + "com.docusign.documentation-path": "", + + "ESignatureManifest": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/eSignatureManifest.json", + + "server.tomcat.additional-tld-skip-patterns": "*jaxb*.jar", + "server.servlet.session.tracking-modes": "cookie", + "server.servlet.session.persistent": false, + "server.error.include-stacktrace": "always", + "server.error.whitelabel.enabled": false, + + "spring.session.store-type": "none", + "spring.mvc.view.prefix": "/WEB-INF/templates/views/", + "spring.mvc.view.suffix": ".jsp", + "spring.jmx.enabled": false +} \ No newline at end of file diff --git a/README.md b/README.md index f054c89d..9c7403fd 100644 --- a/README.md +++ b/README.md @@ -1,205 +1,230 @@ # Java Launcher Code Examples -### Github repo: [code-examples-java](./) +### GitHub repo: [code-examples-java](./README.md) + +This GitHub repo includes code examples for the DocuSign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. + + ## Introduction -This repo is a Java Spring Boot application that demonstrates: - -1. **Embedded Signing Ceremony.** - [Source.](./src/main/java/com/docusign/controller/examples/EG001ControllerEmbeddedSigning.java) - This example sends an envelope, and then uses an embedded signing ceremony for the first signer. - With embedded signing, the DocuSign signing ceremony is initiated from your website. -1. **Send an envelope with a remote (email) signer and cc recipient.** - [Source.](./src/main/java/com/docusign/controller/examples/EG002ControllerSigningViaEmail.java) - The envelope includes a pdf, Word, and HTML document. - Anchor text ([AutoPlace](https://support.docusign.com/en/guides/AutoPlace-New-DocuSign-Experience)) is used to position the signing fields in the documents. -1. **List envelopes in the user's account.** - [Source.](./src/main/java/com/docusign/controller/examples/EG003ControllerListEnvelopes.java) -1. **Get an envelope's basic information.** - [Source.](./src/main/java/com/docusign/controller/examples/EG004ControllerEnvelopeInfo.java) - The example lists the basic information about an envelope, including its overall status. -1. **List an envelope's recipients and their current status.** - [Source.](./src/main/java/com/docusign/controller/examples/EG005ControllerEnvelopeRecipients.java) -1. **List an envelope's documents.** - [Source.](./src/main/java/com/docusign/controller/examples/EG006ControllerEnvelopeDocs.java) -1. **Download an envelope's documents.** The example can download individual - documents, the documents concatenated together, or a zip file of the documents. - [Source.](./src/main/java/com/docusign/controller/examples/EG007ControllerEnvelopeGetDoc.java) -1. **Programmatically create a template.** - [Source.](./src/main/java/com/docusign/controller/examples/EG008ControllerCreateTemplate.java) -1. **Send an envelope using a template.** - [Source.](./src/main/java/com/docusign/controller/examples/EG009ControllerUseTemplate.java) -1. **Send an envelope and upload its documents with multipart binary transfer.** - [Source.](./src/main/java/com/docusign/controller/examples/EG010ControllerSendBinaryDocs.java) - Binary transfer is 33% more efficient than using Base64 encoding. -1. **Embedded sending.** - [Source.](./src/main/java/com/docusign/controller/examples/EG011ControllerEmbeddedSending.java) -1. **Embedded DocuSign web tool (NDSE).** - [Source.](./src/main/java/com/docusign/controller/examples/EG012ControllerEmbeddedConsole.java) -1. **Embedded Signing Ceremony from a template with an added document.** - [Source.](./src/main/java/com/docusign/controller/examples/EG013ControllerAddDocToTemplate.java) - This example sends an envelope based on a template. - In addition to the template's document(s), the example adds an - additional document to the envelope by using the - [Composite Templates](https://developers.docusign.com/esign-rest-api/guides/features/templates#composite-templates) - feature. -1. **Payments example: an order form, with online payment by credit card.** - [Source.](./src/main/java/com/docusign/controller/examples/EG014ControllerCollectPayment.java) -1. **Get the envelope tab data.** - Retrieve the tab (field) values for all of the envelope's recipients. - [Source.](./src/main/java/com/docusign/controller/examples/EG015ControllerGetTabValues.java) -1. **Set envelope tab values.** - The example creates an envelope and sets the initial values for its tabs (fields). Some of the tabs - are set to be read-only, others can be updated by the recipient. The example also stores - metadata with the envelope. - [Source.](./src/main/java/com/docusign/controller/examples/EG016ControllerSetTabValues.java) -1. **Set template tab values.** - The example creates an envelope using a template and sets the initial values for its tabs (fields). - The example also stores metadata with the envelope. - [Source.](./src/main/java/com/docusign/controller/examples/EG017ControllerSetTemplateTabValues.java) -1. **Get the envelope custom field data (metadata).** - The example retrieves the custom metadata (custom data fields) stored with the envelope. - [Source.](./src/main/java/com/docusign/controller/examples/EG018ControllerEnvelopeCustomFieldValues.java) -1. **Requiring an Access Code for a Recipient** - [Source.](./src/main/java/com/docusign/controller/examples/EG019ControllerAccessCodeAuthentication.java) - This example sends and envelope that requires an access-code for the purpose of multi-factor authentication. -1. **Requiring SMS authentication for a recipient** - [Source.](./src/main/java/com/docusign/controller/examples/EG020ControllerSmsAuthentication.java) - This example sends and envelope that requires entering in a six digit code from an text message for the purpose of multi-factor authentication. -1. **Requiring Phone authentication for a recipient** - [Source.](./src/main/java/com/docusign/controller/examples/EG021ControllerPhoneAuthentication.java) - This example sends and envelope that requires entering in a voice-based response code for the purpose of multi-factor authentication. -1. **Requiring Knowledge-Based Authentication (KBA) for a Recipient** - [Source.](./src/main/java/com/docusign/controller/examples/EG022ControllerKBAAuthentication.java) - This example sends and envelope that requires passing a Public records check to validate identity for the purpose of multi-factor authentication. -1. **Requiring ID Verification (IDV) for a recipient** - [Source.](./src/main/java/com/docusign/controller/examples/EG023ControllerIdvAuthentication.java) - This example sends and envelope that requires the recipient to upload a government issued id. - **Creating a permission profile** - [Source.](./src/main/java/com/docusign/controller/examples/EG024ControllerPermissionCreate.java) - This code example demonstrates how to create a user group's permission profile using the [Create Profile](https://developers.docusign.com/esign-rest-api/reference/UserGroups/Groups/create) method. -1. **Setting a permission profile** - [Source.](./src/main/java/com/docusign/controller/examples/EG025ControllerPermissionSetUserGroups.java) - This code example demonstrates how to set a user group's permission profile using the [Update Group](https://developers.docusign.com/esign-rest-api/reference/UserGroups/Groups/update) method. - You must have already created permissions profile and group of users. -1. **Updating individual permission settings** - [Source.](./src/main/java/com/docusign/controller/examples/EG026ControllerPermissionChangeSingleSetting.java) - This code example demonstrates how to update individual settings for a specific permission profile using the [Update Permission Profile](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountPermissionProfiles/update) method. - You must have already created permissions profile and group of users. -1. **Deleting a permission profile** - [Source.](./src/main/java/com/docusign/controller/examples/EG027ControllerPermissionDelete.java) - This code example demonstrates how to an account's permission profile using the [Delete AccountPermissionProfiles](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountPermissionProfiles/delete) method. -1. **Creating a brand** - [Source.](./src/main/java/com/docusign/controller/examples/EG028ControllerCreateBrand.java) - This example creates brand profile for an account using the [Create Brand](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountBrands/create) method. -1. **Applying a brand to an envelope** - [Source.](./src/main/java/com/docusign/controller/examples/EG029ControllerApplyBrandToEnvelope.java) - This code example demonstrates how to apply a brand you've created to an envelope using the [Create Envelope](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create) method. - First, creates the envelope and then applies brand to it. - Anchor text ([AutoPlace](https://support.docusign.com/en/guides/AutoPlace-New-DocuSign-Experience)) is used to position the signing fields in the documents. -1. **Applying a brand to a template** - [Source.](./src/main/java/com/docusign/controller/examples/EG030ControllerApplyBrandToTemplate.java) - This code example demonstrates how to apply a brand you've created to a template using using the [Create Envelope](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create) method. - You must have at least one created template and brand. - -1. **Bulk sending envelopes to multiple recipients** - [Source.](./src/main/java/com/docusign/controller/examples/EG031ControllerBulkSendEnvelopes.java) - This example creates and sends a bulk envelope by generating a bulk recipient list and initiating a bulk send. - - - -## Included OAuth grant types: - -* Authentication with Docusign via [Authorization Code Grant flow](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) . -When the token expires, the user is asked to re-authenticate. -The **refresh token** is not used in this example. - -* Authentication with DocuSign via the [JSON Web Token (JWT) Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken). + +This repo is a Java Spring Boot application that supports the following authentication workflows: + +* Authentication with DocuSign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode). +When the token expires, the user is asked to re-authenticate. The refresh token is not used. + +* Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/). When the token expires, it updates automatically. +The [Spring Boot security Oauth2 boot autoconfigure package](https://github.com/spring-projects/spring-security-oauth2-boot/blob/master/spring-security-oauth2-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/resource/UserInfoRestTemplateCustomizer.java) is used for authentication. -## Installation +The OAuth library is used in the file [WebSecurityConfig.java](https://github.com/docusign/code-examples-java/blob/master/src/main/java/com/docusign/WebSecurityConfig.java). -### Prerequisites -1. A DocuSign Developer Sandbox account (email and password) on [demo.docusign.net](https://demo.docusign.net). - Create a [free account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16533). -1. A DocuSign Integration Key (a client ID) that is configured to use the - OAuth Authorization Code flow. - You will need the **Integration Key** itself, and its **secret**. To - use JSON Web token, you will need the **Integration Key** itself, the - **RSA Secret Key** and an API user ID for the user you are impersonating. - - If you use this example on your own workstation, - the Integration key must include following **Redirect URI**s: - * http://localhost:8080/login&type=acg - * http://localhost:8080/login&type=jwt - If you will not be running the example on your own workstation, - use the appropriate DNS name and port instead of `localhost:8080`. - An example Redirect URI: http://myserver.it.mycompany.com/login +## eSignature API + +For more information about the scopes used for obtaining authorization to use the eSignature API, see [Required scopes](https://developers.docusign.com/docs/esign-rest-api/esign101/auth#required-scopes). + +For a list of code examples that use the eSignature API, see the [How-to guides overview](https://developers.docusign.com/docs/esign-rest-api/how-to/) on the DocuSign Developer Center. + -1. Java 11. -1. A name and email for a signer, and a name and email for a cc recipient. - The signer and the cc email cannot be the same. -1. Maven +## Rooms API -### Short installation instructions -* Download or clone this repository. -* The project includes a Maven pom file. -* Create a file `code-examples-java/src/main/resources/application-dev.properties` and configure the project by overriding necessary properties from the `application.properties` file. **Don't add this file into the Git index.** -* Add VM argument `-Dspring.profiles.active=dev` to your IDE -* Note that IntelliJ Community Edition does not directly support - Spring Boot applications. +**Note:** To use the Rooms API, you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the DocuSign Forms feature enabled in your Rooms for Real Estate account. +For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/rooms-api/rooms101/auth/). -### Build and run -Examples are built as a dedicated application with embedded TomCat server. Build: -``` bash -$ cd code-examples-java -$ mvn package -``` -Run: -``` bash -$ cd target -$ java -Dspring.profiles.active=dev -jar code-examples-java-1.0-SNAPSHOT.war -``` +For a list of code examples that use the Rooms API, see the [How-to guides overview](https://developers.docusign.com/docs/rooms-api/how-to/) on the DocuSign Developer Center. -### IntelliJ Ultimate installation -See the [IntelliJ Ultimate instructions](https://github.com/docusign/eg-03-java-auth-code-grant/blob/master/docs/Readme_IntelliJ_Ultimate.md). +## Click API +For more information about the scopes used for obtaining authorization to use the Click API, see [Required scopes](https://developers.docusign.com/docs/click-api/click101/auth/#required-scopes) -## Configure the example +For a list of code examples that use the Click API, see the [How-to guides overview](https://developers.docusign.com/docs/click-api/how-to/) on the DocuSign Developer Center. -Configure the example via the properties file: -`eg-03-java-auth-code-grant/src/main/resources/application-dev.properties`. -Add the client id, secret, signer name and email to the file. -Also add the URL that the application will use (the **DS_APP_URL** setting). -By default, this is http://localhost:8080 +## Monitor API -You must also add a **Redirect URI** to the client id's settings in -DocuSign. The Redirect URIs are `/login&type=acg` and `/login&type=jwt` appended to the DS_APP_URL setting. -Eg http://localhost:8080/login&type=acg +**Note:** To use the Monitor API, you must also [enable DocuSign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/). -### Payments code example -To use the payments example, create a -test payments gateway for your developer sandbox account. +For information about the scopes used for obtaining authorization to use the Monitor API, see the [scopes section](https://developers.docusign.com/docs/monitor-api/monitor101/auth/). -See the -[PAYMENTS_INSTALLATION.md](https://github.com/docusign/eg-03-java-auth-code-grant/blob/master/PAYMENTS_INSTALLATION.md) -file for instructions. +For a list of code examples that use the Monitor API, see the [How-to guides overview](https://developers.docusign.com/docs/monitor-api/how-to/) on the DocuSign Developer Center. -Then add the payment gateway account id to the **application.properties** file. -## Using the examples with other authentication flows +## Admin API -The examples in this repository can also be used with the -JWT OAuth flow. -See the [Authentication guide](https://developers.docusign.com/esign-rest-api/guides/authentication) -for information on choosing the right authentication flow for your application. +**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your DocuSign developer account. Also, to run the DocuSign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM). -## License and additional information +For information about the scopes used for obtaining authorization to use the Admin API, see the [scopes section](https://developers.docusign.com/docs/admin-api/admin101/auth/). + +For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the DocuSign Developer Center. + + +## Installation + +### Prerequisites +**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip items 1 and 2 as they were automatically performed for you. + +1. A free [DocuSign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one. +1. A DocuSign app and integration key that is configured to use either [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) or [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication. + + This [video](https://www.youtube.com/watch?v=eiRI4fe5HgM) demonstrates how to obtain an integration key. + + To use [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/), you will need an integration key and a secret key. See [Installation steps](#installation-steps) for details. + + To use [JWT Grant](https://developers.docusign.com/platform/auth/jwt/), you will need an integration key, an RSA key pair, and the User ID GUID of the impersonated user. See [Installation steps for JWT Grant authentication](#installation-steps-for-jwt-grant-authentication) for details. + + For both authentication flows: + + If you use this launcher on your own workstation, the integration key must include redirect URIs of + + * http://localhost:8080/login&type=acg + * http://localhost:8080/login&type=jwt -### License -This repository uses the MIT License. See the LICENSE file for more information. + If you host this launcher on a remote web server, set your redirect URI as + + {base_url}/login + + where {base_url} is the URL for the web app. + +1. Download [JDK 11](https://jdk.java.net/java-se-ri/11) or later and extract to C:\Program Files\Java +1. Download [Maven](https://maven.apache.org/download.cgi) and extract to C: + * Follow these [instructions](https://maven.apache.org/install.html) to add both Java and Maven to the `PATH` environment variable. +1. [Git Bash command line](https://gitforwindows.org/), macOS Terminal, or Linux shell + + +### Installation steps + +**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip step 4 as it was automatically performed for you. + +1. Extract the Quickstart ZIP file or download or clone the code-examples-java repository. +1. In your command-line environment, switch to the : + `cd ` or `cd code-examples-java` +1. Package the code: `mvn package` +1. To configure the launcher for [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) authentication, create a copy of the file src/main/resources/application.example.json and save the copy as src/main/resources/application.json. + 1. Add your User ID. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **My Account Information**, copy the **User ID** GUID and save it in application.json as your `DS_TARGET_ACCOUNT_ID`. + 1. Add your integration key. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **Apps and Integration Keys**, choose the app to use, then select **Actions > Edit**. Under **General Info**, copy the **Integration Key** GUID and save it in application.json as your `authorization.code.grant.client.client-id`. + 1. Generate a secret key, if you don’t already have one. Under **Authentication**, select **+ ADD SECRET KEY**. Copy the secret key and save it in application.json as your `authorization.code.grant.client.client-secret`. + 1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of http://localhost:8080/login&type=acg. Select **SAVE**. + 1. Set a name and email address for the signer. In application.json, save an email address as `DS_SIGNER_EMAIL` and a name as `DS_SIGNER_NAME`. +**Note:** Protect your personal information. Please make sure that application.json will not be stored in your source code repository. + +#### Multiple code examples, Authorization Code Grant, and JWT Grant: +1. $ `cd ` +1. $ `mvn package -Dmaven.test.skip=true` +1. $ `java -Dspring.profiles.active=dev -jar target/code-examples-java-1.0-SNAPSHOT.war` + For Windows: +1. $ `mvn package -D"maven.test.skip"="true"` +1. $ `java -D"spring.profiles.active"="dev" -jar target/code-examples-java-1.0-SNAPSHOT.war` + +#### Authorization Code Grant embedded signing example: + +1. $ `cd /Quick_ACG` +1. $ `mvn spring-boot:run -Drun.profiles=dev` +For Windows: +1. $ `mvn spring-boot:run -D"run.profiles"="dev"` + +#### JWT grant remote signing example: +1. $ `cd /'JWT Console App'` +1. $ `mvn compile` +1. $ `mvn exec:java -Dexec.mainClass="com.docusign.jwtconsoleapp.JWTConsoleApp"` + For Windows +1. $ `mvn exec:java -D"exec.mainClass"="com.docusign.jwtconsoleapp.JWTConsoleApp"` + + +### Installation steps for JWT Grant authentication + +**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip step 4 as it was automatically performed for you. +Also, in order to select JSON Web Token authentication in the launcher, in src/main/resources/application.json, change the `quickstart` setting to `false`. + +1. Extract the Quickstart ZIP file or download or clone the code-examples-java repository. +1. In your command-line environment, switch to the folder: `cd ` or `cd code-examples-java` +1. Package the code: `mvn package` +1. To configure the launcher for [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication, create a copy of the file src/main/resources/application.example.json and save the copy as src/main/resources/application.json. + 1. Add your User ID. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **My Account Information**, copy the **User ID** GUID and save it in application.json as your `DS_TARGET_ACCOUNT_ID` and as your `jwt.grant.client.impersonated-user-guid`. + 1. Add your integration key. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **Apps and Integration Keys**, choose the app to use, then select **Actions > Edit**. Under **General Info**, copy the **Integration Key** GUID and save it in application.json as your `jwt.grant.client.client-id`. + 1. Generate an RSA key pair, if you don’t already have one. Under **Authentication**, select **+ GENERATE RSA**. Copy the private key, and save it in a new file named src/main/resources/private.key. + 1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of http://localhost:8080/login&type=jwt. Select **SAVE**. + 1. Set a name and email address for the signer. In application.json, save an email address as `DS_SIGNER_EMAIL` and a name as `DS_SIGNER_NAME`. +**Note:** Protect your personal information. Please make sure that application.json will not be stored in your source code repository. +1. Run the launcher: `mvn exec:java -Dexec.mainClass="com.docusign.jwtconsoleapp.JWTConsoleApp"` (`mvn exec:java -D"exec.mainClass"="com.docusign.jwtconsoleapp.JWTConsoleApp"`) + The launcher automatically opens. +1. On the black navigation bar, select **Login**. +1. From the picklist, select **JSON Web Token (JWT) grant** > **Authenticate with DocuSign**. +1. When prompted, log in to your DocuSign developer account. If this is your first time using the app, select **ACCEPT** at the consent window. +3. Select your desired code example. + + +## IntelliJ Ultimate instructions for Windows + +IntelliJ IDEA can be used with the launcher. The [IntelliJ IDEA Ultimate edition](https://www.jetbrains.com/idea/download/#section=windows) is required due to its support for Spring Boot and JSP view pages. + +**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip step 2 as it was automatically performed for you. + +1. Extract the Quickstart ZIP file or download or clone the code-examples-java repository. +1. To configure the launcher for [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) authentication, create a copy of the file src/main/resources/application.example.json and save the copy as src/main/resources/application.json. + 1. Add your User ID. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **My Account Information**, copy the **User ID** GUID and save it in application.json as your `DS_TARGET_ACCOUNT_ID`. + 1. Add your integration key. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **Apps and Integration Keys**, choose the app to use, then select **Actions > Edit**. Under **General Info**, copy the **Integration Key** GUID and save it in application.json as your `authorization.code.grant.client.client-id`. + 1. Generate a secret key, if you don’t already have one. Under **Authentication**, select **+ ADD SECRET KEY**. Copy the secret key and save it in application.json as your `authorization.code.grant.client.client-secret`. + 1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of http://localhost:8080/login&type=acg. Select **SAVE**. + 1. Set a name and email address for the signer. In application.json, save an email address as `DS_SIGNER_EMAIL` and a name as `DS_SIGNER_NAME`. +**Note:** Protect your personal information. Please make sure that application.json will not be stored in your source code repository. +1. Start IntelliJ IDEA Ultimate. In the **Welcome to IntelliJ IDEA** dialog box, select **Open**. + 1. In the **Open File or Project** dialog box, select your Quickstart folder or code-examples-java, then select **OK**. + 1. In **Open or Import Project** dialog box, select **Maven project**, then select **OK**. +1. Create a Java application configuration: In the top navigation bar, select **Run** > **Edit configurations**. + 1. In the far left corner, select **+** > **Spring Boot**. + 1. To the right of **Main class**, select **... > App (com.docusign) code-examples-java**, then select **OK**. + 1. Under **Spring Boot**, select the **Enable debug output** checkbox, then select **OK**. +1. Run the launcher: In the top navigation bar, select **Run > Run 'App'**. The launcher automatically opens. + When prompted, log in to your DocuSign developer account. If this is your first time using the app, select **ACCEPT** at the consent window. +1. [Optional] To install Lombok, select **File > Settings > Plugins > Marketplace** tab. To the right of the magnifying glass icon, input: `Lombok` + It should have an author named Michail Plushnikov. Select **Install**, then restart IntelliJ. + + +## Eclipse instructions for Windows + +**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/) from the DocuSign Developer Center, skip step 2 as it was automatically performed for you. + +1. Extract the Quickstart ZIP file or download or clone the code-examples-java repository. +1. To configure the launcher for [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) authentication, create a copy of the file src/main/resources/application.example.json and save the copy as src/main/resources/application.json. + 1. Add your User ID. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **My Account Information**, copy the **User ID** GUID and save it in application.json as your `DS_TARGET_ACCOUNT_ID`. + 1. Add your integration key. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **Apps and Integration Keys**, choose the app to use, then select **Actions > Edit**. Under **General Info**, copy the **Integration Key** GUID and save it in application.json as your `authorization.code.grant.client.client-id`. + 1. Generate a secret key, if you don’t already have one. Under **Authentication**, select **+ ADD SECRET KEY**. Copy the secret key and save it in application.json as your `authorization.code.grant.client.client-secret`. + 1. Add the launcher’s redirect URI. Under **Additional settings**, select **+ ADD URI**, and set a redirect URI of http://localhost:8080/login&type=acg. Select **SAVE**. + 1. Set a name and email address for the signer. In application.json, save an email address as `DS_SIGNER_EMAIL` and a name as `DS_SIGNER_NAME`. +**Note:** Protect your personal information. Please make sure that application.json will not be stored in your source code repository. + +1. Open Eclipse and select **File > Import**. In the **Import** dialog box, select **Existing Maven Project > Next > Browse**, browse for your Quickstart folder or code-examples-java, then **Select Folder**. + 1. Under **Projects**, the `pom.xml` file should be selected. + 1. To save the project link to your Eclipse workspace, select the **Add project(s) to working set** checkbox. Select **Finish**. +1. Next, select **Run**, then **Run Configurations**, and right-click **Maven Build**, then **New Configuration** to clean and compile the package. + 1. In the **Name** field, input: `build` + 1. In **Base directory**, input: `${workspace_loc:/code-examples-java}` + 1. In **Goals**, input: `clean package` + 1. Select the **JRE** tab. Under **Runtime JRE**, ensure it lists jdk-11 or higher. Select **Apply** to save. +1. In the **Run Configurations** dialog box, in the left sidebar, right-click **Java Application**, then select **New Configuration**. + 1. In the **Name** field, input: `App` + 1. In the **Project** field, input: `code-examples-java` + 1. In the **Main class** field, input: `com.docusign.App` + 1. Select the **JRE** tab. Under **Runtime JRE**, ensure it lists jdk-11 or higher. Select **Apply** to save. + 1. Select **Run** to run the launcher. The launcher automatically opens. + When prompted, log in to your DocuSign developer account. If this is your first time using the app, select **ACCEPT** at the consent window. +1. [Optional] Download [lombok.jar](https://projectlombok.org/downloads/lombok.jar) to your local machine, then run the following command to install Lombok: `java -jar lombok.jar` + +## JWT grant remote signing project +See [DocuSign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the DocuSign Developer Center for more information on how to run the JWT grant remote signing project. + +## Payments code example + +To use the payments code example, create a test payment gateway on the [**Payments**](https://admindemo.docusign.com/authenticate?goTo=payments) page in your developer account. See [Configure a payment gateway](./PAYMENTS_INSTALLATION.md) for details. + +Once you've created a payment gateway, save the **Gateway Account ID** GUID to application.json. + + +## License and additional information + +### License +This repository uses the MIT License. See [LICENSE](./LICENSE) for details. ### Pull Requests Pull requests are welcomed. Pull requests will only be considered if their content diff --git a/azure-pipelines.yml b/azure-pipelines.yml new file mode 100644 index 00000000..da8417ef --- /dev/null +++ b/azure-pipelines.yml @@ -0,0 +1,113 @@ +# Starter pipeline +# Start with a minimal pipeline that you can customize to build and deploy your code. +# Add steps that build, run tests, deploy, and more: +# https://aka.ms/yaml +resources: + repositories: + - repository: launcher-automation + type: github + name: docusign/launcher-automation + ref: main + endpoint: launcherAutomationServiceConnection + +pr: +- master +- releases/* + +pool: + name: launcher-automation-pool + +steps: +- script: echo Hello, world! + displayName: 'Run a one-line script' +- checkout: self +- checkout: launcher-automation + +- script: dir $(Build.SourcesDirectory) + +- task: DownloadSecureFile@1 + name: java_dockerfile + displayName: 'download Dockerfile' + inputs: + secureFile: 'java.Dockerfile' + +- script: | + echo "place java.Dockerfile" + echo $(java_dockerfile.secureFilePath) + cp $(java_Dockerfile.secureFilePath) code-examples-java-private/Dockerfile + displayName: 'place Dockerfile' + +- script: | + allure –-version + java --version + javac --version + mvn --version + docker --version + +- task: DownloadSecureFile@1 + name: tests_config_properties + displayName: 'download config.properties' + inputs: + secureFile: 'java-php.config.properties' + + +- script: | + echo "place config.properties" + echo $(tests_config_properties.secureFilePath) + cp $(tests_config_properties.secureFilePath) launcher-automation/src/main/resources/config.properties + displayName: 'place config.properties' + +- task: DownloadSecureFile@1 + name: java_application + displayName: 'download application.json' + inputs: + secureFile: 'java.application.json' + + +- script: | + echo "place application.json" + cp $(java_application.secureFilePath) code-examples-java-private/src/main/resources/application.json + displayName: 'place application.json' + + +- task: DownloadSecureFile@1 + name: java_private_key + displayName: 'download private.key' + inputs: + secureFile: 'private.key' + + +- script: | + echo "place private.key" + cp $(java_private_key.secureFilePath) code-examples-java-private/src/main/resources/private.key + displayName: 'place private.key' + +- script: dir $(Build.SourcesDirectory) + +- script: dir $(Build.SourcesDirectory)/code-examples-java-private + +- script: dir $(Build.SourcesDirectory)/code-examples-java-private/src/main/resources + +- task: Docker@2 + displayName: Build java image + inputs: + command: build + repository: 'launcher-automation-java' + dockerfile: '$(Build.SourcesDirectory)/code-examples-java-private/Dockerfile' + buildContext: '$(Build.SourcesDirectory)/code-examples-java-private ' + tags: | + latest + +- script: | + docker run -p 8080:8080 -d launcher-automation-java:latest + displayName: 'start java app' + +- script: | + cd launcher-automation + mvn clean test -DsuiteXmlFile="java_suite.xml" + displayName: 'Java app tests' + +- script: | + docker stop $(docker ps -a -q) + docker rm $(docker ps -a -q) + displayName: 'stop java app' \ No newline at end of file diff --git a/checkstyle.xml b/checkstyle.xml new file mode 100644 index 00000000..57627a62 --- /dev/null +++ b/checkstyle.xml @@ -0,0 +1,51 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/code-examples-java.iml b/code-examples-java.iml index 6d509eea..1effdd89 100644 --- a/code-examples-java.iml +++ b/code-examples-java.iml @@ -1,16 +1,23 @@ + + - - - + + + + + + + @@ -18,91 +25,101 @@ + - - - - - - - - + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Adding_examples.md b/docs/Adding_examples.md index 757641a8..dd9b40aa 100644 --- a/docs/Adding_examples.md +++ b/docs/Adding_examples.md @@ -25,11 +25,11 @@ Examples should be self-contained within the scope of the launcher. For example, if your example operates on a template, -then either use the template created by example number 8, -or modify the template created by example 8 (eg add a field), +then either use the template created by Create a template, +or modify the template created by Create a template (eg add a field), or programmatically create a new template. -If you plan to change example 8, first discuss with the +If you plan to change Create a template, first discuss with the Examples Manager via apihelp@docusign.com. Do not require a user to create or modify a template by diff --git a/docs/IntelliJ_import_highlight.jpg b/docs/IntelliJ_import_highlight.jpg new file mode 100644 index 00000000..0ca31bba Binary files /dev/null and b/docs/IntelliJ_import_highlight.jpg differ diff --git a/docs/Readme_IntelliJ_Ultimate.md b/docs/Readme_IntelliJ_Ultimate.md deleted file mode 100644 index 071ab7e4..00000000 --- a/docs/Readme_IntelliJ_Ultimate.md +++ /dev/null @@ -1,58 +0,0 @@ -# IntelliJ installation - -The [IntelliJ IDE Ultimate edition](https://www.jetbrains.com/idea/) -can be used with the example. The IntelliJ Ultimate edition is -required due to its support for Spring Boot and JSP view pages. - -**Step 1.** Download or clone the -[eg-03-java-auth-code-grant](https://github.com/docusign/eg-03-java-auth-code-grant) - repository - -**Step 2.** Start IntelliJ Ultimate and choose the **Import Project** option. - -![IntelliJ Import project](install_fig_1.png) - -**Step 3.** Use the popup file chooser to select the -**code-examples-java** directory. - -**Step 4.** The **Import Project** wizard will open. It's a -series of screens. On the first screen, select -**Import project from external model** and **Maven**. - -![IntelliJ Import Maven project](install_fig_2.png) - -**Step 5.** Click **Finish** and the project will -be displayed in the IDE. - -## Configuring the project -Configure the example as discussed in the repository's Readme. - -## Running the example - -### Configuring the IDE's *Run/Debug Configuration* -IntelliJ uses **Run/Debug Configurations** to manage -settings for running the example. - -**One time:** setup a Run/Debug Configuration for the example: - -Step 1. Use the menu command **Run / Edit configurations...** -to open the configuration manager. - -Step 2. Click the **+** (plus) sign to add a new configuration. -The configuration type is **Spring Boot**. You may need to -open the additional templates section of the template chooser. - -Step 3. Update the form with the **Name** of the -configuration and the **Main class** for the configuration, -`com.docusign.App` **Tip:** use the **...** (ellipses) button next to the field to choose the Main class. - -Tip: check the **Enable debug output** checkbox. - -![Configure a Run configuration](install_fig_7.png) - -### Running or debugging the example - -Use a **Run** menu option to run or debug the example. - -After the application is ready for requests, open your -browser to http://localhost:8080 diff --git a/docs/ds-java-auth-final.zip b/docs/ds-java-auth-final.zip new file mode 100644 index 00000000..c18317e4 Binary files /dev/null and b/docs/ds-java-auth-final.zip differ diff --git a/docs/lombok_errors.png b/docs/lombok_errors.png new file mode 100644 index 00000000..bbe873cb Binary files /dev/null and b/docs/lombok_errors.png differ diff --git a/pom.xml b/pom.xml index a8236905..8881190f 100644 --- a/pom.xml +++ b/pom.xml @@ -1,12 +1,14 @@ - + 4.0.0 org.springframework.boot spring-boot-starter-parent - 2.2.1.RELEASE - + 2.5.12 + com.docusign @@ -17,55 +19,127 @@ Docusign Java Tutorial + src/main + src/test/java + 11 - 2.1.1.RELEASE - 2.6 - 3.5.0 + 2.5.6 + 2.11.0 + + 4.4.0 + 1.4.3 + 1.4.0 + 1.3.0 + 1.3.0 + 2.2.8 + 2.14.2 + 3.0.9 + org.springframework.boot spring-boot-starter-security + org.springframework.boot spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-oauth2-client + + - org.springframework.security.oauth.boot - spring-security-oauth2-autoconfigure - ${oauth2.version} + io.github.cdimascio + dotenv-java + 2.2.0 org.projectlombok lombok + 1.18.22 true org.apache.commons commons-lang3 + org.freemarker freemarker + com.google.code.gson gson - + + com.fasterxml.jackson.datatype + jackson-datatype-joda + + + + com.fasterxml.jackson.datatype + jackson-datatype-jsr310 + + + + io.swagger.core.v3 + swagger-annotations + ${swagger-core-version} + + + + com.fasterxml.jackson.jakarta.rs + jackson-jakarta-rs-base + ${jackson-version} + + + + jakarta.ws.rs + jakarta.ws.rs-api + 3.1.0 + + + + javax.ws.rs + javax.ws.rs-api + 2.0.1 + + + + javax.servlet + javax.servlet-api + + + + commons-codec + commons-codec + 1.15 + + javax.servlet jstl + + + org.json + json + 20231013 + + org.apache.tomcat.embed tomcat-embed-jasper - provided @@ -73,15 +147,72 @@ commons-io ${commonsio.version} + com.docusign docusign-esign-java - ${docusign.version} + ${esignature.version} + + + + com.docusign + docusign-rooms-java + ${rooms.version} + shaded + + + + com.docusign + docusign-click-java + ${click.version} + shaded + + + + com.docusign + docusign-monitor-java + ${monitor.version} + shaded + + + + com.docusign + docusign-admin-java + ${admin.version} + shaded + + + + org.springframework.boot + spring-boot-autoconfigure + + + + org.glassfish.jersey.media + jersey-media-json-jackson + ${jersey2.version} + + + + junit + junit + test + + + + org.junit.jupiter + junit-jupiter-params + test + + org.apache.maven.plugins + maven-surefire-plugin + + org.springframework.boot spring-boot-maven-plugin @@ -89,7 +220,28 @@ true + + + org.apache.maven.plugins + maven-checkstyle-plugin + 3.1.2 + + checkstyle.xml + warning + true + + + + + + + org.bouncycastle + bcprov-jdk15on + 1.69 + + + diff --git a/src/main/java/com/docusign/App.java b/src/main/java/com/docusign/App.java index 9c829ef7..9598d85d 100644 --- a/src/main/java/com/docusign/App.java +++ b/src/main/java/com/docusign/App.java @@ -1,16 +1,85 @@ package com.docusign; +import lombok.extern.slf4j.Slf4j; import org.springframework.boot.SpringApplication; -import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Import; +import java.awt.*; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.file.FileSystemAlreadyExistsException; +import java.nio.file.FileSystems; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Collections; + +@Slf4j +@SpringBootApplication(exclude = {JmxAutoConfiguration.class}) +@ComponentScan(basePackages = "com.docusign") +@Import(WebSecurityConfig.class) -@SpringBootApplication -@EnableAutoConfiguration(exclude={JmxAutoConfiguration.class}) public class App { - public static void main(String[] args) { - SpringApplication.run(App.class, args); + public static void main(String[] args) throws IOException, URISyntaxException { + initFileSystem(); + + ClassLoader classLoader = App.class.getClassLoader(); + URL applicationJsonURL = classLoader.getResource("application.json"); + + if (applicationJsonURL != null) { + SpringApplication.run(App.class, args); + openHomePage(); + } else { + InputStream inputStream = classLoader.getResourceAsStream("applicationJsonMissingError.html"); + + if (inputStream.available() > 0) { + Path path = Files.createTempFile("applicationJsonMissingError", ".html"); + try (FileOutputStream out = new FileOutputStream(path.toFile())) { + byte[] buffer = new byte[1024]; + int len; + while ((len = inputStream.read(buffer)) != -1) { + out.write(buffer, 0, len); + } + } catch (IOException e) { + log.error("File applicationJsonMissingError.html could not be accessed."); + } + + Desktop.getDesktop().browse(path.toUri()); + } + + log.info(""); + log.info("Please, add the application.json file to the resources folder."); + log.info(""); + } + } + + private static void openHomePage() throws IOException { + System.setProperty("java.awt.headless", "false"); + try { + Desktop.getDesktop().browse(new URI("http://localhost:8080")); + } catch (URISyntaxException use) { + log.error("Invalid URI in App.openHomePage()"); + } + } + + private static void initFileSystem() { + try { + FileSystems.newFileSystem(new URI(""), Collections.emptyMap()); + log.info("FileSystem initialized successfully"); + } catch (Exception e) { + if (e instanceof FileSystemAlreadyExistsException) { + log.info("FileSystem is already initialized"); + } else { + log.info("Retrieving the default initialize context"); + FileSystems.getDefault(); + } + } } } diff --git a/src/main/java/com/docusign/DSConfiguration.java b/src/main/java/com/docusign/DSConfiguration.java index c536e46e..11261b94 100644 --- a/src/main/java/com/docusign/DSConfiguration.java +++ b/src/main/java/com/docusign/DSConfiguration.java @@ -1,26 +1,63 @@ package com.docusign; +import com.docusign.common.ApiIndex; +import com.docusign.core.model.ApiType; +import com.docusign.core.model.manifestModels.ManifestStructure; +import com.docusign.esign.client.auth.OAuth; +import com.fasterxml.jackson.databind.ObjectMapper; +import jakarta.ws.rs.HttpMethod; +import jakarta.ws.rs.core.HttpHeaders; import lombok.Getter; +import lombok.Setter; import org.springframework.beans.factory.annotation.Value; +import org.springframework.http.MediaType; import org.springframework.stereotype.Component; +import java.io.BufferedReader; +import java.io.InputStreamReader; +import java.net.HttpURLConnection; +import java.net.URL; @Component @Getter +@Setter public class DSConfiguration { + public Boolean isConsentRedirectActivated = false; + + public String apiTypeHeader = "ApiType"; + @Value("${com.docusign.github.example-uri}") private String exampleUrl; @Value("${com.docusign.documentation-path}") private String documentationPath; + private String selectedApiType; + + private ManifestStructure codeExamplesText; + + private boolean additionalRedirect; + + private boolean shareAccessExampleScenario; + + private String principalUserId; + @Value("${DS_TARGET_ACCOUNT_ID}") private String targetAccountId; @Value("${DS_APP_URL}") private String appUrl; + @Value("${DS_BASE_PATH}") + private String basePath; + + @Value("${DS_ROOMS_BASE_PATH}") + private String roomsBasePath; + + @Value("${DS_CLICK_BASE_PATH}") + private String clickBasePath; + @Value("${DS_SIGNER_EMAIL:{USER_EMAIL}}") private String signerEmail; @@ -30,12 +67,45 @@ public class DSConfiguration { @Value("${Gateway_Account_Id}") private String gatewayAccountId; + @Value("${spring.security.oauth2.client.registration.jwt.client-id}") + private String userId; + + @Value("${jwt.grant.sso.redirect-url}") + private String jwtRedirectURL; + + @Value("${authorization.code.grant.sso.redirect-url}") + private String acgRedirectURL; + + @Value("${spring.security.oauth2.client.registration.jwt.private-key-path}") + private String privateKeyPath; + + @Value("${spring.security.oauth2.client.registration.jwt.impersonated-user-guid}") + private String impersonatedUserId; + + @Value("${jwt.grant.client.base-url}") + private String baseURL; + @Value("${Gateway_Name}") private String gatewayName; @Value("${Gateway_Display_Name}") private String gatewayDisplayName; + @Value("${quickstart:{quickstart}}") + private String quickstart; + + @Value("${quickACG:{quickACG}}") + private String quickACG; + + @Value("${DS_MONITOR_BASE_PATH}") + private String monitorBasePath; + + @Value("${DS_ADMIN_BASE_PATH}") + private String adminBasePath; + + @Value("${CodeExamplesManifest}") + private String codeExamplesManifest; + public String getDsReturnUrl() { return appUrl + "/ds-return"; } @@ -43,4 +113,75 @@ public String getDsReturnUrl() { public String getDsPingUrl() { return appUrl + "/"; } -} + + public String getBaseUrl(ApiIndex apiIndex, OAuth.Account oauthAccount) { + if (ApiIndex.ROOMS.equals(apiIndex)) { + return roomsBasePath; + } else if (ApiIndex.CLICK.equals(apiIndex)) { + return clickBasePath; + } else if (ApiIndex.MONITOR.equals(apiIndex)) { + return monitorBasePath; + } else if (ApiIndex.ADMIN.equals(apiIndex)) { + return adminBasePath; + } + + return oauthAccount.getBaseUri(); + } + + public ApiType getSelectedApiType() { + if (selectedApiType == null) { + return ApiType.ESIGNATURE; + } + + return ApiType.valueOf(selectedApiType); + } + + public ApiIndex getSelectedApiIndex() { + if (selectedApiType == null) { + return ApiIndex.ESIGNATURE; + } + + return ApiIndex.valueOf(selectedApiType); + } + + public ManifestStructure getCodeExamplesText() { + if (codeExamplesText != null) { + return codeExamplesText; + } + + try { + codeExamplesText = new ObjectMapper().readValue(loadFileData(codeExamplesManifest), ManifestStructure.class); + } catch (Exception e) { + e.printStackTrace(); + } + + return codeExamplesText; + } + + public String loadFileData(String linkToManifestFile) throws Exception { + URL fullRequestPath = new URL(linkToManifestFile); + HttpURLConnection httpConnection = (HttpURLConnection) fullRequestPath.openConnection(); + httpConnection.setRequestMethod(HttpMethod.GET); + + httpConnection.setRequestProperty( + HttpHeaders.CONTENT_TYPE, + String.valueOf(MediaType.APPLICATION_JSON)); + + int responseCode = httpConnection.getResponseCode(); + + if (responseCode < HttpURLConnection.HTTP_OK || responseCode >= HttpURLConnection.HTTP_BAD_REQUEST) { + throw new Exception(httpConnection.getResponseMessage()); + } + + BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(httpConnection.getInputStream())); + StringBuilder stringBuilder = new StringBuilder(); + String temp; + while ((temp = bufferedReader.readLine()) != null) { + stringBuilder.append(temp); + } + bufferedReader.close(); + httpConnection.disconnect(); + + return stringBuilder.toString(); + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/EG001ControllerEmbeddedSigning.java b/src/main/java/com/docusign/EG001ControllerEmbeddedSigning.java new file mode 100644 index 00000000..a8efac5f --- /dev/null +++ b/src/main/java/com/docusign/EG001ControllerEmbeddedSigning.java @@ -0,0 +1,107 @@ +package com.docusign; + +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.examples.AbstractEsignatureController; +import com.docusign.controller.eSignature.services.EmbeddedSigningService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.RecipientViewRequest; +import com.docusign.esign.model.ViewUrl; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.servlet.view.RedirectView; + +import javax.servlet.http.HttpServletResponse; + + +/** + * Use embedded signing. + * This example sends an envelope, and then uses embedded signing + * for the first signer. Embedded signing provides a smoother user experience + * for the signer: the DocuSign signing is initiated from your site. + */ +@Controller +@RequestMapping("/eg001") +public class EG001ControllerEmbeddedSigning extends AbstractEsignatureController { + + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "Lorem Ipsum"; + + private static final int ANCHOR_OFFSET_Y = 20; + + private static final int ANCHOR_OFFSET_X = 10; + + private static final String SIGNER_CLIENT_ID = "1000"; + + @Autowired + public EG001ControllerEmbeddedSigning(DSConfiguration config, Session session, User user) { + super(config, Boolean.valueOf(config.getQuickACG()) ? "quickEmbeddedSigning" : "eg001", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + if (config.getQuickstart().equals("true")) { + config.setQuickstart("false"); + } + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws Exception { + String signerName = args.getSignerName(); + String signerEmail = args.getSignerEmail(); + String accountId = session.getAccountId(); + + // Create the envelope definition + //ds-snippet-start:eSign1Step3 + EnvelopeDefinition envelope = EmbeddedSigningService.makeEnvelope( + signerEmail, + signerName, + SIGNER_CLIENT_ID, + ANCHOR_OFFSET_Y, + ANCHOR_OFFSET_X, + DOCUMENT_FILE_NAME, + DOCUMENT_NAME); + + // Call DocuSign to create the envelope + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + + String envelopeId = EmbeddedSigningService.createEnvelope(apiClient, session.getAccountId(), envelope); + //ds-snippet-end + session.setEnvelopeId(envelopeId); + + // Create the recipient view, the embedded signing + //ds-snippet-start:eSign1Step5 + RecipientViewRequest viewRequest = EmbeddedSigningService.makeRecipientViewRequest( + signerEmail, + signerName, + SIGNER_CLIENT_ID, + config.getDsReturnUrl(), + config.getDsPingUrl()); + + ViewUrl viewUrl = EmbeddedSigningService.embeddedSigning( + apiClient, + accountId, + envelopeId, + viewRequest + ); + + // Redirect the user to the embedded signing + // Don't use an iFrame! + // State can be stored/recovered using the framework's session or a + // query parameter on the returnUrl (see the makeRecipientViewRequest method) + return new RedirectView(viewUrl.getUrl()); + //ds-snippet-end + } +} diff --git a/src/main/java/com/docusign/HttpsConnectWebhookhMacValidation.java b/src/main/java/com/docusign/HttpsConnectWebhookhMacValidation.java new file mode 100644 index 00000000..21abfe83 --- /dev/null +++ b/src/main/java/com/docusign/HttpsConnectWebhookhMacValidation.java @@ -0,0 +1,59 @@ +package com.docusign; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.crypto.Mac; +import javax.crypto.spec.SecretKeySpec; +import java.io.IOException; +import java.io.UnsupportedEncodingException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.security.InvalidKeyException; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.Base64; + +public class HttpsConnectWebhookhMacValidation { + + private static final Logger LOGGER = LoggerFactory.getLogger(HttpsConnectWebhookhMacValidation.class); + + /* + * Useful reference: + * https://docs.oracle.com/javase/10/docs/api/javax/crypto/Mac.html + * https://docs.oracle.com/javase/10/docs/specs/security/standard-names.html#mac + * -algorithms + */ + //ds-snippet-start:Connect1Step1 + private static String ComputeHash(String secret, byte[] payload) + throws InvalidKeyException, NoSuchAlgorithmException { + String digest = "HmacSHA256"; + Mac mac = Mac.getInstance(digest); + mac.init(new SecretKeySpec(secret.getBytes(), digest)); + String base64Hash = new String(Base64.getEncoder().encode(mac.doFinal(payload))); + return base64Hash; + } + + public static boolean HashIsValid(String secret, byte[] payload, String verify) + throws InvalidKeyException, NoSuchAlgorithmException, UnsupportedEncodingException { + String computedHash = ComputeHash(secret, payload); + boolean isEqual = MessageDigest.isEqual(computedHash.getBytes(StandardCharsets.UTF_8), + verify.getBytes(StandardCharsets.UTF_8)); + return isEqual; + } + //ds-snippet-end:Connect1Step1 + public static void main(String[] args) { + + LOGGER.info("DocuSign HMAC Tester"); + try { + Boolean response = HttpsConnectWebhookhMacValidation.HashIsValid("{DocuSign HMAC private key}", + Files.readAllBytes(Paths.get("payload.txt")), "{JSON response Signature}"); + LOGGER.info("is this HMAC Valid? "); + LOGGER.info(String.valueOf(response)); + } catch (Exception e) { + LOGGER.error("Error!!! "); + LOGGER.error(e.getMessage()); + } + } +} diff --git a/src/main/java/com/docusign/JsonPropertySourceLoader.java b/src/main/java/com/docusign/JsonPropertySourceLoader.java new file mode 100644 index 00000000..c25de2fe --- /dev/null +++ b/src/main/java/com/docusign/JsonPropertySourceLoader.java @@ -0,0 +1,10 @@ +package com.docusign; + +import org.springframework.boot.env.YamlPropertySourceLoader; + +public class JsonPropertySourceLoader extends YamlPropertySourceLoader { + @Override + public String[] getFileExtensions() { + return new String[]{"json"}; + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/WebSecurityConfig.java b/src/main/java/com/docusign/WebSecurityConfig.java index bcfd93d6..74288ef7 100644 --- a/src/main/java/com/docusign/WebSecurityConfig.java +++ b/src/main/java/com/docusign/WebSecurityConfig.java @@ -1,142 +1,53 @@ package com.docusign; -import com.docusign.security.OAuthProperties; -import com.docusign.security.jwt.JWTAuthorizationCodeResourceDetails; -import com.docusign.security.jwt.JWTOAuth2RestTemplate; -import com.docusign.security.jwt.JWTUserInfoTokenService; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.autoconfigure.security.oauth2.client.OAuth2SsoProperties; -import org.springframework.boot.autoconfigure.security.oauth2.resource.ResourceServerProperties; -import org.springframework.boot.autoconfigure.security.oauth2.resource.UserInfoTokenServices; -import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.security.config.annotation.SecurityConfigurerAdapter; +import org.springframework.security.config.Customizer; import org.springframework.security.config.annotation.web.builders.HttpSecurity; -import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter; -import org.springframework.security.oauth2.client.OAuth2ClientContext; -import org.springframework.security.oauth2.client.OAuth2RestTemplate; -import org.springframework.security.oauth2.client.filter.OAuth2ClientAuthenticationProcessingFilter; -import org.springframework.security.oauth2.client.filter.OAuth2ClientContextFilter; -import org.springframework.security.oauth2.client.token.grant.code.AuthorizationCodeResourceDetails; -import org.springframework.security.oauth2.config.annotation.web.configuration.EnableOAuth2Client; -import org.springframework.security.oauth2.provider.token.ResourceServerTokenServices; -import org.springframework.security.web.DefaultSecurityFilterChain; +import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; +import org.springframework.security.web.SecurityFilterChain; import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint; -import org.springframework.security.web.authentication.preauth.AbstractPreAuthenticatedProcessingFilter; -import org.springframework.web.filter.CompositeFilter; +import org.springframework.security.web.savedrequest.HttpSessionRequestCache; +import org.springframework.security.web.savedrequest.RequestCache; -import java.util.Arrays; -import java.util.List; -import javax.servlet.Filter; - -@EnableOAuth2Client -@Configuration -public class WebSecurityConfig extends WebSecurityConfigurerAdapter { +@EnableWebSecurity +public class WebSecurityConfig { @Autowired - private OAuth2ClientContext oAuth2ClientContext; - - @Bean - @ConfigurationProperties("authorization.code.grant.sso") - public OAuthProperties authCodeGrantSso() { - return new OAuthProperties(); - } - - @Bean - @ConfigurationProperties("jwt.grant.sso") - public OAuthProperties jwtGrantSso() { - return new OAuthProperties(); - } - - @Bean - @ConfigurationProperties("authorization.code.grant.client") - public AuthorizationCodeResourceDetails authCodeGrantClient() { - return new AuthorizationCodeResourceDetails(); - } - - @Bean - @ConfigurationProperties("jwt.grant.client") - public JWTAuthorizationCodeResourceDetails jwtCodeGrantClient() { - return new JWTAuthorizationCodeResourceDetails(); - } + public DSConfiguration dsConfiguration; @Bean - @ConfigurationProperties("common.client.resource") - public ResourceServerProperties userInfoResource() { - return new ResourceServerProperties(); + public RequestCache requestCache() { + return new HttpSessionRequestCache(); } @Bean - public FilterRegistrationBean oAuth2ClientFilterRegistration(OAuth2ClientContextFilter oAuth2ClientContextFilter) { - FilterRegistrationBean registration = new FilterRegistrationBean<>(); - registration.setFilter(oAuth2ClientContextFilter); - registration.setOrder(-100); - return registration; - } - - private OAuth2ClientAuthenticationProcessingFilter authCodeGrantFilter() { - OAuth2SsoProperties authCodeGrantSso = authCodeGrantSso(); - AuthorizationCodeResourceDetails authCodeGrantClient = authCodeGrantClient(); - ResourceServerProperties userInfoResource = userInfoResource(); - OAuth2ClientAuthenticationProcessingFilter filter = - new OAuth2ClientAuthenticationProcessingFilter(authCodeGrantSso.getLoginPath()); - OAuth2RestTemplate restTemplate = new OAuth2RestTemplate(authCodeGrantClient, oAuth2ClientContext); - filter.setRestTemplate(restTemplate); - ResourceServerTokenServices tokenServices = new UserInfoTokenServices(userInfoResource.getUserInfoUri(), - authCodeGrantClient.getClientId()); - filter.setTokenServices(tokenServices); - return filter; - } - - private OAuth2ClientAuthenticationProcessingFilter jwtGrantFilter() { - OAuth2SsoProperties authCodeGrantSso = jwtGrantSso(); - JWTAuthorizationCodeResourceDetails jwtCodeGrantClient = jwtCodeGrantClient(); - OAuth2ClientAuthenticationProcessingFilter filter = - new OAuth2ClientAuthenticationProcessingFilter(authCodeGrantSso.getLoginPath()); - OAuth2RestTemplate restTemplate = new JWTOAuth2RestTemplate(jwtCodeGrantClient, oAuth2ClientContext); - filter.setRestTemplate(restTemplate); - ResourceServerTokenServices tokenServices = new JWTUserInfoTokenService(jwtCodeGrantClient); - filter.setTokenServices(tokenServices); - return filter; - } - - @Override - protected void configure(HttpSecurity http) throws Exception { - + public SecurityFilterChain filterChain(HttpSecurity http) throws Exception { http - .antMatcher("/**") - .authorizeRequests() - .antMatchers( "/", "/login**", "/error**", "/assets/**","/ds/mustAuthenticate**", - "/ds/authenticate**") - .permitAll() - .anyRequest() - .authenticated() - .and() - .exceptionHandling() - .authenticationEntryPoint(new LoginUrlAuthenticationEntryPoint("/ds/mustAuthenticate")) - .and() - .logout().logoutSuccessUrl("/").permitAll() - .and() - .csrf().disable(); - http.apply(new CombinedAuthenticationConfigurer(Arrays.asList(authCodeGrantFilter(), - jwtGrantFilter()))); - } - - private static class CombinedAuthenticationConfigurer - extends SecurityConfigurerAdapter { - - CompositeFilter filter = new CompositeFilter(); - - CombinedAuthenticationConfigurer(List filters) { - filter.setFilters(filters); - } - - @Override - public void configure(HttpSecurity builder) { - builder.addFilterAfter(this.filter, - AbstractPreAuthenticatedProcessingFilter.class); - } - } -} + .authorizeHttpRequests(authorize -> { + try { + authorize + .antMatchers("/", "/error**", "/assets/**", "/ds/mustAuthenticate**", + "/ds/authenticate**", "/ds/selectApi**", "/con001") + .permitAll() + .anyRequest().authenticated() + .and() + .exceptionHandling() + .authenticationEntryPoint( + new LoginUrlAuthenticationEntryPoint("/ds/mustAuthenticate") + ); + } catch (Exception e) { + throw new RuntimeException(e); + } + }) + .requestCache().requestCache(requestCache()).and() + .oauth2Login(Customizer.withDefaults()) + .oauth2Client(Customizer.withDefaults()) + .logout(logout -> logout + .logoutSuccessUrl("/") + ) + .csrf().disable(); + + return http.build(); + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/common/ApiIndex.java b/src/main/java/com/docusign/common/ApiIndex.java new file mode 100644 index 00000000..8f75c210 --- /dev/null +++ b/src/main/java/com/docusign/common/ApiIndex.java @@ -0,0 +1,41 @@ +package com.docusign.common; + +public enum ApiIndex { + ESIGNATURE("/pages/esignature/index", "/restapi", "/eg001", "/eg"), + ROOMS("/pages/rooms/index", "/restapi", "/r001", "/r"), + CLICK("/pages/click/index", "/clickapi", "/c001", "/c"), + MONITOR("/pages/monitor/index", "", "/m001", "/m"), + ADMIN("/pages/admin/index", "/management", "/a001", "/a"), + CONNECT("/pages/connect/index", "", "/con001", "/con"); + private final String indexPath; + + private final String baseUrlSuffix; + + private final String firstExamplePath; + + private final String examplesPathCode; + + ApiIndex(final String indexPath, final String baseUrlSuffix, final String firstExamplePath, final String examplesPathCode) { + this.indexPath = indexPath; + this.baseUrlSuffix = baseUrlSuffix; + this.firstExamplePath = firstExamplePath; + this.examplesPathCode = examplesPathCode; + } + + public String getBaseUrlSuffix() { + return baseUrlSuffix; + } + + public String getPathOfFirstExample() { + return firstExamplePath; + } + + public String getExamplesPathCode() { + return examplesPathCode; + } + + @Override + public String toString() { + return this.indexPath; + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/common/WorkArguments.java b/src/main/java/com/docusign/common/WorkArguments.java new file mode 100644 index 00000000..acfc28ba --- /dev/null +++ b/src/main/java/com/docusign/common/WorkArguments.java @@ -0,0 +1,178 @@ +package com.docusign.common; + +import lombok.Data; +import org.springframework.context.annotation.Scope; +import org.springframework.stereotype.Component; +import org.springframework.web.context.WebApplicationContext; + +import java.util.UUID; + + +@Component +@Scope(value = WebApplicationContext.SCOPE_REQUEST) +@Data +public class WorkArguments { + private String item; + + private String quantity; + + private String signerEmail; + + private String signerName; + + private String ccEmail; + + private String ccName; + + private String clickwrapName; + + private String signerEmail2; + + private String signerName2; + + private String ccEmail2; + + private String ccName2; + + private String status; + + private String startingView; + + private String dsReturnUrl; + + private String dsPingUrl; + + private String signerClientId; + + private String signerCheckedEmail; + + private String signerCheckedName; + + private String signerNotCheckedEmail; + + private String signerNotCheckedName; + + private String docSelect; + + private String accessCode; + + private String brandName; + + private String language; + + private String brandId; + + private String templateId; + + private String profileId; + + private String groupId; + + private String permissionProfileName; + + private String phoneNumber; + + private Integer roleId; + + private String roomName; + + private Integer roomTemplateId; + + private Integer roomId; + + private Integer officeId; + + private UUID formId; + + private String formGroupName; + + private UUID formGroupId; + + private String startDate; + + private String endDate; + + private String deliveryMethod; + + private String ccPhoneNumber; + + private String countryCode; + + private String ccCountryCode; + + private String email; + + private String userName; + + private String firstName; + + private String lastName; + + private String clmProfileId; + + private UUID clmProductId; + + private String eSignProfileId; + + private UUID eSignProductId; + + private String PermissionProfileId; + + private UUID ProductId; + + private UUID dsGroupId; + + private UUID userId; + + private String resumeDate; + + private String delay; + + private String clickwrap; + + private String clickwrapId; + + private String documentId; + + private String hostEmail; + + private String hostName; + + private String fullName; + + private String company; + + private String title; + + private String date; + + private String candidateEmail; + + private String candidateName; + + private String managerName; + + private String jobTitle; + + private String salary; + + private String agentEmail; + + private String agentName; + + private String activationCode; + + private UUID sourceAccountId; + + private String targetAccountName; + + private String targetAccountFirstName; + + private String targetAccountLastName; + + private String targetAccountEmail; + + private String hmacSecret; + + private String jsonPayload; +} diff --git a/src/main/java/com/docusign/controller/IndexController.java b/src/main/java/com/docusign/controller/IndexController.java deleted file mode 100644 index ccee7808..00000000 --- a/src/main/java/com/docusign/controller/IndexController.java +++ /dev/null @@ -1,91 +0,0 @@ -package com.docusign.controller; - -import com.docusign.model.AuthType; -import com.docusign.model.Session; -import com.docusign.security.OAuthProperties; -import java.util.List; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.util.MultiValueMap; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.RequestBody; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.RequestMethod; -import org.springframework.web.bind.annotation.RequestParam; -import org.springframework.web.servlet.ModelAndView; -import org.springframework.web.servlet.view.RedirectView; - - -@Controller -public class IndexController { - - private static final String ATTR_ENVELOPE_ID = "qpEnvelopeId"; - private static final String ATTR_STATE = "state"; - private static final String ATTR_EVENT = "event"; - private static final String ATTR_TITLE = "title"; - - @Autowired - private Session session; - - @Autowired - private OAuthProperties jwtGrantSso; - - @Autowired - private OAuthProperties authCodeGrantSso; - - @GetMapping(path = "/") - public String index(ModelMap model) { - model.addAttribute(ATTR_TITLE,"Home"); - return "pages/index"; - } - - @GetMapping(path = "/ds/mustAuthenticate") - public ModelAndView mustAuthenticateController(ModelMap model) { - model.addAttribute(ATTR_TITLE, "Authenticate with DocuSign"); - if (session.isRefreshToken()) { - return new ModelAndView(getRedirectView(session.getAuthTypeSelected())); - } - return new ModelAndView("pages/ds_must_authenticate"); - } - - @RequestMapping(path = "/ds/authenticate", method = RequestMethod.POST) - public RedirectView authenticate(ModelMap model, - @RequestBody MultiValueMap formParams) { - if (!formParams.containsKey("selectAuthType")) { - model.addAttribute("message", - "select option with selectAuthType name must be provided"); - return new RedirectView("pages/error"); - } - List selectAuthTypeObject = formParams.get("selectAuthType"); - AuthType authTypeSelected = AuthType.valueOf(selectAuthTypeObject.get(0)); - return getRedirectView(authTypeSelected); - } - - @GetMapping(path = "/ds-return") - public String returnController(@RequestParam(value=ATTR_STATE, required = false) String state, - @RequestParam(value=ATTR_EVENT, required = false) String event, - @RequestParam(value="envelopeId", required = false) String envelopeId, - ModelMap model) { - model.addAttribute(ATTR_TITLE , "Return from DocuSign"); - model.addAttribute(ATTR_EVENT, event); - model.addAttribute(ATTR_STATE, state); - model.addAttribute(ATTR_ENVELOPE_ID, envelopeId); - return "pages/ds_return"; - } - - private RedirectView getRedirectView(AuthType authTypeSelected) { - session.setAuthTypeSelected(authTypeSelected); - RedirectView redirect = new RedirectView(getLoginPath(authTypeSelected)); - redirect.setExposeModelAttributes(false); - return redirect; - } - - private String getLoginPath(AuthType authTypeSelected) { - OAuthProperties oAuth2SsoProperties = authCodeGrantSso; - if (authTypeSelected.equals(AuthType.JWT)) { - oAuth2SsoProperties = jwtGrantSso; - } - return oAuth2SsoProperties.getLoginPath(); - } -} diff --git a/src/main/java/com/docusign/controller/admin/examples/A001AddActiveUser.java b/src/main/java/com/docusign/controller/admin/examples/A001AddActiveUser.java new file mode 100644 index 00000000..035d1919 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A001AddActiveUser.java @@ -0,0 +1,117 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.client.ApiException; +import com.docusign.admin.model.NewUserResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.AddActiveUserService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.api.GroupsApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.model.GroupInformation; +import com.docusign.esign.model.PermissionProfileInformation; +import jakarta.ws.rs.core.HttpHeaders; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + +/** + * Create new user + * This example demonstrates how to create a new user with methods from Admin API. + */ +@Controller +@RequestMapping("/a001") +public class A001AddActiveUser extends AbstractAdminController { + + private static final Logger LOGGER = LoggerFactory.getLogger(A001AddActiveUser.class); + + private static final String MODEL_LIST_PROFILES = "listProfiles"; + + private static final String MODEL_LIST_GROUPS = "listGroups"; + + @Autowired + public A001AddActiveUser(DSConfiguration config, Session session, User user) { + super(config, "a001", user, session); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + + try { + super.onInitModel(args, model); + LOGGER.info("super called"); + //ds-snippet-start:Admin1Step2 + ApiClient apiClient = new ApiClient("https://demo.docusign.net/restapi"); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + user.getAccessToken()); + //ds-snippet-end:Admin1Step2 + LOGGER.info("API client called"); + + //ds-snippet-start:Admin1Step3 + AccountsApi accountsApi = new AccountsApi(apiClient); + LOGGER.info(this.user.getAccessToken()); + LOGGER.info(this.session.getBasePath()); + + UUID orgId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + LOGGER.info("we have an org id: " + orgId); + UUID accountId = this.getExistingAccountId(this.user.getAccessToken(), this.session.getBasePath(), orgId); + LOGGER.info("An accountID: " + accountId); + PermissionProfileInformation permissionsInfo = accountsApi.listPermissions(String.valueOf(accountId)); + //ds-snippet-end:Admin1Step3 + LOGGER.info("and permissions info too: " + permissionsInfo); + model.addAttribute(MODEL_LIST_PROFILES, permissionsInfo.getPermissionProfiles()); + + //ds-snippet-start:Admin1Step4 + GroupsApi groupsApi = new GroupsApi(apiClient); + GroupInformation groupInformation = groupsApi.listGroups(String.valueOf(accountId)); + //ds-snippet-end:Admin1Step4 + + model.addAttribute(MODEL_LIST_GROUPS, groupInformation.getGroups()); + } catch (ApiException e) { + LOGGER.info(String.valueOf(e)); + } + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + LOGGER.info("doWork function called"); + String accessToken = this.user.getAccessToken(); + String basePath = this.session.getBasePath(); + // Create a users api instance + UsersApi usersApi = createUsersApi(accessToken, basePath); + + // Collect ids needed for the request + UUID organizationId = this.getOrganizationId(accessToken, basePath); + + //ds-snippet-start:Admin1Step5 + UUID accountId = this.getExistingAccountId(accessToken, basePath, organizationId); + //ds-snippet-end:Admin1Step5 + NewUserResponse result = AddActiveUserService.createNewActiveUser( + args.getGroupId(), + args.getProfileId(), + args.getEmail(), + args.getUserName(), + args.getFirstName(), + args.getLastName(), + usersApi, + organizationId, + accountId); + + // Process results + DoneExample + .createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(result) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A002CreateActiveCLMESignUser.java b/src/main/java/com/docusign/controller/admin/examples/A002CreateActiveCLMESignUser.java new file mode 100644 index 00000000..5328a779 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A002CreateActiveCLMESignUser.java @@ -0,0 +1,120 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.DsGroupsApi; +import com.docusign.admin.api.ProductPermissionProfilesApi; +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.client.ApiException; +import com.docusign.admin.model.AddUserResponse; +import com.docusign.admin.model.DSGroupListResponse; +import com.docusign.admin.model.ProductPermissionProfileResponse; +import com.docusign.admin.model.ProductPermissionProfilesResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.CreateActiveCLMESignUserService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + +/** + * Create new user This example demonstrates how to create a new user with + * methods from Admin API. + */ +@Controller +@RequestMapping("/a002") +public class A002CreateActiveCLMESignUser extends AbstractAdminController { + + @Autowired + public A002CreateActiveCLMESignUser(DSConfiguration config, Session session, User user) { + super(config, "a002", user, session); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + UUID accountId = this.getExistingAccountId(user.getAccessToken(), session.getBasePath(), organizationId); + + //ds-snippet-start:Admin2Step3 + ProductPermissionProfilesApi permissionsInfo = this.createProductPermissionProfilesApi(user.getAccessToken(), + session.getBasePath()); + ProductPermissionProfilesResponse profiles = permissionsInfo.getProductPermissionProfiles(organizationId, + accountId); + ProductPermissionProfileResponse clmProfiles = null; + ProductPermissionProfileResponse eSignProfiles = null; + UUID clmProductId = null; + UUID eSignProductId = null; + // filter by each type per response + for (ProductPermissionProfileResponse eachOne : profiles.getProductPermissionProfiles()) { + if (eachOne.getProductName().equals("CLM")) { + clmProductId = eachOne.getProductId(); + clmProfiles = eachOne; + } else { + eSignProductId = eachOne.getProductId(); + eSignProfiles = eachOne; + } + } + //ds-snippet-end:Admin2Step3 + + //ds-snippet-start:Admin2Step4 + DsGroupsApi groupsApi = this.createDSGroupsApi(user.getAccessToken(), session.getBasePath()); + DSGroupListResponse groups = groupsApi.getDSGroups(organizationId, accountId); + //ds-snippet-end:Admin2Step4 + + // set CLM permission profiles + model.addAttribute("listCLM", clmProfiles); + model.addAttribute("clmProductId", clmProductId); + + // set eSign permission profiles + model.addAttribute("listeSign", eSignProfiles); + model.addAttribute("eSignProductId", eSignProductId); + + model.addAttribute("listGroups", groups); + + if (groups.getTotalCount() == 0) { + throw new ApiException(getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessage); + } + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + String accessToken = this.user.getAccessToken(); + String basePath = this.session.getBasePath(); + // Create a users api instance + UsersApi usersApi = createUsersApi(accessToken, basePath); + + // Collect ids needed for the request + UUID organizationId = this.getOrganizationId(accessToken, basePath); + UUID accountId = this.getExistingAccountId(accessToken, basePath, organizationId); + + AddUserResponse result = CreateActiveCLMESignUserService.createNewActiveUser( + args.getClmProfileId(), + args.getClmProductId(), + args.getESignProfileId(), + args.getESignProductId(), + args.getDsGroupId(), + args.getUserName(), + args.getFirstName(), + args.getLastName(), + args.getEmail(), + usersApi, + organizationId, + accountId); + + this.session.setEmailAddress(result.getEmail()); + + // Process results + DoneExample + .createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(result) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A003BulkExportUserData.java b/src/main/java/com/docusign/controller/admin/examples/A003BulkExportUserData.java new file mode 100644 index 00000000..d71522ab --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A003BulkExportUserData.java @@ -0,0 +1,76 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.BulkExportsApi; +import com.docusign.admin.model.OrganizationExportResponse; +import com.docusign.admin.model.OrganizationExportsResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.BulkExportUserDataService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.concurrent.TimeUnit; + +/** + * How to bulk-export user data This example demonstrates how to bulk-export + * user data from Admin API. + */ +@Controller +@RequestMapping("/a003") +public class A003BulkExportUserData extends AbstractAdminController { + + private static final int BUFFER_SIZE = 4096; + + @Autowired + public A003BulkExportUserData(DSConfiguration config, Session session, User user) { + super(config, "a003", user, session); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + //ds-snippet-start:Admin3Step3 + BulkExportsApi bulkExportsApi = createBulkExportsApi(this.user.getAccessToken(), this.session.getBasePath()); + + OrganizationExportResponse bulkList = BulkExportUserDataService.createUserListExport( + bulkExportsApi, + this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath())); + //ds-snippet-end:Admin3Step3 + + TimeUnit.SECONDS.sleep(30); + + //ds-snippet-start:Admin3Step4 + OrganizationExportResponse data = BulkExportUserDataService.bulkExportUserData( + bulkExportsApi, + this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()), + bulkList.getId()); + //ds-snippet-end:Admin3Step4 + + String saveFilePath = ""; + + if (data.getResults() != null && !data.getResults().isEmpty()) { + String csvUri = data.getResults().get(0).getUrl(); + saveFilePath = BulkExportUserDataService.moveUserListExportToFile( + csvUri, + BEARER_AUTHENTICATION, + this.user.getAccessToken(), + BUFFER_SIZE + ); + } + + OrganizationExportsResponse results = BulkExportUserDataService + .bulkExportsUserData(bulkExportsApi, this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath())); + // Process results + DoneExample + .createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText.replaceFirst("\\{0}", saveFilePath)) + .withJsonObject(results).addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A003aCheckRequestStatus.java b/src/main/java/com/docusign/controller/admin/examples/A003aCheckRequestStatus.java new file mode 100644 index 00000000..5c137c98 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A003aCheckRequestStatus.java @@ -0,0 +1,58 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.BulkExportsApi; +import com.docusign.admin.model.OrganizationExportResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.CheckRequestStatusService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.apache.commons.lang3.StringUtils; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + +/** + * Check request status + * This example demonstrates how to check request status from the Admin API. + */ +@Controller +@RequestMapping("/a003a") +public class A003aCheckRequestStatus extends AbstractAdminController { + private static final String MODEL_EXPORT_OK = "exportOk"; + + @Autowired + public A003aCheckRequestStatus(DSConfiguration config, Session session, User user) { + super(config, "a003a", user, session); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + model.addAttribute(MODEL_EXPORT_OK, StringUtils.isNotBlank(this.session.getExportId())); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + // Create a bulk exports api instance + BulkExportsApi bulkExportsApi = createBulkExportsApi(this.user.getAccessToken(), this.session.getBasePath()); + + OrganizationExportResponse result = CheckRequestStatusService.checkRequestStatus( + bulkExportsApi, + this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()), + UUID.fromString(this.session.getExportId())); + + // Process results + DoneExample + .createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().AdditionalPage.get(0).ResultsPageText) + .withJsonObject(result) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A004BulkImportUserData.java b/src/main/java/com/docusign/controller/admin/examples/A004BulkImportUserData.java new file mode 100644 index 00000000..524f743a --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A004BulkImportUserData.java @@ -0,0 +1,59 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.BulkImportsApi; +import com.docusign.admin.model.OrganizationImportResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.BulkImportUserDataService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + + +/** + * How to add users via bulk import + * This example demonstrates how to add users via bulk import from the Admin API. + */ +@Controller +@RequestMapping("/a004") +public class A004BulkImportUserData extends AbstractAdminController { + + @Autowired + public A004BulkImportUserData(DSConfiguration config, Session session, User user) { + super(config, "a004", user, session); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + OrganizationImportResponse result = bulkImportUserData(this.user.getAccessToken()); + + this.session.setImportId(result.getId().toString()); + + // Process results + DoneExample + .createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(result) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + + protected OrganizationImportResponse bulkImportUserData(String accessToken) throws Exception { + // Collect ids and user data needed for the request + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + UUID accountId = this.getExistingAccountId(accessToken, this.session.getBasePath(), organizationId); + // Make sure you're using a verified domain for auto-activation to work properly + //ds-snippet-start:Admin4Step3 + BulkImportsApi bulkImportsApi = createBulkImportsApi(accessToken, this.session.getBasePath()); + + return BulkImportUserDataService.bulkImportUserData(bulkImportsApi, organizationId, accountId); + //ds-snippet-end:Admin4Step3 + } +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A004CheckImportRequestStatus.java b/src/main/java/com/docusign/controller/admin/examples/A004CheckImportRequestStatus.java new file mode 100644 index 00000000..174be25b --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A004CheckImportRequestStatus.java @@ -0,0 +1,82 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.BulkImportsApi; +import com.docusign.admin.model.OrganizationImportResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.CheckImportRequestStatusService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.apache.commons.lang3.StringUtils; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.servlet.view.RedirectView; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + + +/** + * Check request status + * This example demonstrates how to check request status from the Admin API. + */ +@Controller +@RequestMapping("/a004a") +public class A004CheckImportRequestStatus extends AbstractAdminController { + private static final String MODEL_IMPORT_OK = "importOk"; + + @Autowired + public A004CheckImportRequestStatus(DSConfiguration config, Session session, User user) { + super(config, "a004a", user, session); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + model.addAttribute(MODEL_IMPORT_OK, StringUtils.isNotBlank(this.session.getImportId())); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + // Redirects to the front facing example to avoid a Null Pointer Exception + if (this.session.getImportId() == null) { + return new RedirectView("a004"); + } + + OrganizationImportResponse result = checkRequestStatus(this.user.getAccessToken()); + if (result.getStatus().equals("queued")) { + // Return the refresh page + DoneExample.createDefault("Request not complete") + .withMessage("The request has not completed, please refresh this page") + .addToModel(model, config); + return EXAMPLE_PENDING_PAGE; + + } + + // Clear the import ID to remove 'Check Status link' from the results page + this.session.setImportId(null); + + // Process results + DoneExample + .createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(result) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + + protected OrganizationImportResponse checkRequestStatus(String accessToken) throws Exception { + // Create a bulk exports api instance + BulkImportsApi bulkImportsApi = createBulkImportsApi(accessToken, this.session.getBasePath()); + //ds-snippet-start:Admin4Step4 + return CheckImportRequestStatusService.checkRequestStatus( + bulkImportsApi, + this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()), + UUID.fromString(this.session.getImportId())); + //ds-snippet-end:Admin4Step4 + } + +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A005AuditUsers.java b/src/main/java/com/docusign/controller/admin/examples/A005AuditUsers.java new file mode 100644 index 00000000..44e1d313 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A005AuditUsers.java @@ -0,0 +1,51 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.model.UserDrilldownResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.AuditUsersService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.ArrayList; +import java.util.UUID; + +/** + * Create new user This example demonstrates how to create a new user with + * methods from Admin API. + */ +@Controller +@RequestMapping("/a005") +public class A005AuditUsers extends AbstractAdminController { + + @Autowired + public A005AuditUsers(DSConfiguration config, Session session, User user) { + super(config, "a005", user, session); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + // Collect ids needed for the request + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + UUID accountId = this.getExistingAccountId(this.user.getAccessToken(), this.session.getBasePath(), organizationId); + + UsersApi usersApi = createUsersApi(this.user.getAccessToken(), this.session.getBasePath()); + + ArrayList resultsArr = AuditUsersService.auditUsers(usersApi, organizationId, accountId); + + // Process results + DoneExample + .createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(resultsArr).addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A006RetrieveDocuSignProfileByEmailAddress.java b/src/main/java/com/docusign/controller/admin/examples/A006RetrieveDocuSignProfileByEmailAddress.java new file mode 100644 index 00000000..ea4b2767 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A006RetrieveDocuSignProfileByEmailAddress.java @@ -0,0 +1,46 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.model.UsersDrilldownResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.RetrieveDocuSignProfileByEmailAddress; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + +/** + * Get a DocuSign user by the email address using the methods from Admin API. + */ +@Controller +@RequestMapping("/a006") +public class A006RetrieveDocuSignProfileByEmailAddress extends AbstractAdminController { + + @Autowired + public A006RetrieveDocuSignProfileByEmailAddress(DSConfiguration config, User user, Session session) { + super(config, "a006", user, session); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + //ds-snippet-start:Admin6Step3 + UsersApi usersApi = createUsersApi(this.user.getAccessToken(), this.session.getBasePath()); + UsersDrilldownResponse usersResponse = RetrieveDocuSignProfileByEmailAddress + .getDocuSignProfileByEmailAddress(usersApi, organizationId, args.getEmail()); + //ds-snippet-end:Admin6Step3 + DoneExample + .createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(usersResponse.getUsers()).addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A007RetrieveDocuSignProfileByUserID.java b/src/main/java/com/docusign/controller/admin/examples/A007RetrieveDocuSignProfileByUserID.java new file mode 100644 index 00000000..310d9fe0 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A007RetrieveDocuSignProfileByUserID.java @@ -0,0 +1,49 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.model.UsersDrilldownResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.RetrieveDocuSignProfileByUserId; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + +/** + * Get a DocuSign user by the user ID using the methods from Admin API. + */ +@Controller +@RequestMapping("/a007") +public class A007RetrieveDocuSignProfileByUserID extends AbstractAdminController { + + @Autowired + public A007RetrieveDocuSignProfileByUserID(DSConfiguration config, User user, Session session) { + super(config, "a007", user, session); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + //ds-snippet-start:Admin7Step3 + UsersApi usersApi = createUsersApi(this.user.getAccessToken(), this.session.getBasePath()); + + UsersDrilldownResponse usersResponse = RetrieveDocuSignProfileByUserId. + getDocuSignProfileByUserId(usersApi, organizationId, args.getUserId()); + //ds-snippet-end:Admin7Step3 + + DoneExample + .createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(usersResponse).addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } + +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A008UpdateUserProductPermissionProfile.java b/src/main/java/com/docusign/controller/admin/examples/A008UpdateUserProductPermissionProfile.java new file mode 100644 index 00000000..fbeda5f2 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A008UpdateUserProductPermissionProfile.java @@ -0,0 +1,135 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.ProductPermissionProfilesApi; +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.client.ApiException; +import com.docusign.admin.model.PermissionProfileResponse21; +import com.docusign.admin.model.ProductPermissionProfileResponse; +import com.docusign.admin.model.ProductPermissionProfilesResponse; +import com.docusign.admin.model.UserProductPermissionProfilesResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.RetrieveDocuSignProfileByEmailAddress; +import com.docusign.controller.admin.services.UpdateUserProductPermissionProfileByEmail; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.MediaType; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.ResponseBody; + +import javax.servlet.http.HttpServletResponse; +import java.util.Hashtable; +import java.util.List; +import java.util.UUID; + +/** + * This example demonstrates how to update user product permission profiles using an email address. + */ +@Controller +@RequestMapping("/a008") +public class A008UpdateUserProductPermissionProfile extends AbstractAdminController { + + private final Hashtable products = new Hashtable<>(); + + private ProductPermissionProfilesResponse productPermissionProfiles; + + @Autowired + public A008UpdateUserProductPermissionProfile(DSConfiguration config, Session session, User user) { + super(config, "a008", user, session); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + UUID existingAccountId = this.getExistingAccountId(user.getAccessToken(), session.getBasePath(), organizationId); + String emailAddress = this.session.getEmailAddress(); + ProductPermissionProfileResponse permissionProfiles = null; + UUID clmProductId = null; + UUID eSignProductId = null; + + if (emailAddress != null) { + try { + UsersApi usersApi = createUsersApi(this.user.getAccessToken(), this.session.getBasePath()); + RetrieveDocuSignProfileByEmailAddress.getDocuSignProfileByEmailAddress(usersApi, organizationId, emailAddress); + + ProductPermissionProfilesApi productPermissionProfilesApi = this.createProductPermissionProfilesApi( + user.getAccessToken(), + session.getBasePath() + ); + productPermissionProfiles = productPermissionProfilesApi.getProductPermissionProfiles(organizationId, existingAccountId); + + for (ProductPermissionProfileResponse profileResponse : productPermissionProfiles.getProductPermissionProfiles()) { + if (profileResponse.getProductName().equals("CLM")) { + clmProductId = profileResponse.getProductId(); + } else { + permissionProfiles = profileResponse; + eSignProductId = profileResponse.getProductId(); + } + } + + products.put(eSignProductId, "eSignature"); + products.put(clmProductId, "CLM"); + + model.addAttribute("listPermissionProfiles", permissionProfiles); + model.addAttribute("listProducts", products); + model.addAttribute("emailAddress", emailAddress); + } catch (ApiException e) { + model.addAttribute("emailAddress", null); + } + } else { + model.addAttribute("emailAddress", null); + } + } + + @RequestMapping(value = "/getPermissionProfiles", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE) + public @ResponseBody + List getPermissionProfiles(@RequestParam(value = "productId") UUID productId) { + List permissionProfiles = null; + for (ProductPermissionProfileResponse profileResponse : productPermissionProfiles.getProductPermissionProfiles()) { + if (profileResponse.getProductId().equals(productId)) { + permissionProfiles = profileResponse.getPermissionProfiles(); + } + } + + return permissionProfiles; + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + UUID existingAccountId = this.getExistingAccountId( + this.user.getAccessToken(), + this.session.getBasePath(), + organizationId + ); + + ProductPermissionProfilesApi productPermissionProfilesApi = createProductPermissionProfilesApi( + this.user.getAccessToken(), + this.session.getBasePath()); + + UserProductPermissionProfilesResponse productPermissionProfile = UpdateUserProductPermissionProfileByEmail + .updateUserProductPermissionProfile( + productPermissionProfilesApi, + args.getPermissionProfileId(), + args.getProductId(), + this.session.getEmailAddress(), + organizationId, + existingAccountId + ); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(productPermissionProfile) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } + +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A009DeleteUserProductPermissionProfile.java b/src/main/java/com/docusign/controller/admin/examples/A009DeleteUserProductPermissionProfile.java new file mode 100644 index 00000000..94b086cc --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A009DeleteUserProductPermissionProfile.java @@ -0,0 +1,138 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.ProductPermissionProfilesApi; +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.client.ApiException; +import com.docusign.admin.model.PermissionProfileResponse21; +import com.docusign.admin.model.ProductPermissionProfileResponse; +import com.docusign.admin.model.RemoveUserProductsResponse; +import com.docusign.admin.model.UserProductPermissionProfilesResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.DeleteUserProductPermissionProfileById; +import com.docusign.controller.admin.services.RetrieveDocuSignProfileByEmailAddress; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.Hashtable; +import java.util.List; +import java.util.UUID; +import java.util.stream.Collectors; + +/** + * This example demonstrates how to delete user product permission profiles using an email address. + */ +@Controller +@RequestMapping("/a009") +public class A009DeleteUserProductPermissionProfile extends AbstractAdminController { + public static UUID clmProductId = UUID.fromString("37f013eb-7012-4588-8028-357b39fdbd00"); + + public static UUID eSignatureProductId = UUID.fromString("f6406c68-225c-4e9b-9894-64152a26fa83"); + + private final Hashtable products = new Hashtable<>(); + + private final String CLM_PROFILES_NOT_FOUND = "No CLM permission profiles are connected to this user"; + + private final String ESIGN_PROFILES_NOT_FOUND = "No eSignature permission profiles are connected to this user"; + + @Autowired + public A009DeleteUserProductPermissionProfile(DSConfiguration config, Session session, User user) { + super(config, "a009", user, session); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + UUID existingAccountId = this.getExistingAccountId(user.getAccessToken(), session.getBasePath(), organizationId); + String emailAddress = this.session.getEmailAddress(); + List clmProfiles = null; + List eSignProfiles = null; + + if (emailAddress != null) { + try { + + UsersApi usersApi = createUsersApi(this.user.getAccessToken(), this.session.getBasePath()); + RetrieveDocuSignProfileByEmailAddress.getDocuSignProfileByEmailAddress(usersApi, organizationId, emailAddress); + + //ds-snippet-start:Admin9Step3 + ProductPermissionProfilesApi productPermissionProfilesApi = this.createProductPermissionProfilesApi( + user.getAccessToken(), + session.getBasePath() + ); + ProductPermissionProfilesApi.GetUserProductPermissionProfilesByEmailOptions userProductPermissionProfilesByEmailOptions = + productPermissionProfilesApi.new GetUserProductPermissionProfilesByEmailOptions(); + userProductPermissionProfilesByEmailOptions.setEmail(emailAddress); + UserProductPermissionProfilesResponse userProductPermissionProfilesByEmail = productPermissionProfilesApi + .getUserProductPermissionProfilesByEmail(organizationId, existingAccountId, userProductPermissionProfilesByEmailOptions); + //ds-snippet-end:Admin9Step3 + for (ProductPermissionProfileResponse profileResponse : userProductPermissionProfilesByEmail.getProductPermissionProfiles()) { + if (profileResponse.getProductName().equals("CLM")) { + clmProfiles = profileResponse + .getPermissionProfiles() + .stream() + .map(PermissionProfileResponse21::getPermissionProfileName) + .collect(Collectors.toList()); + } else { + eSignProfiles = profileResponse + .getPermissionProfiles() + .stream() + .map(PermissionProfileResponse21::getPermissionProfileName) + .collect(Collectors.toList()); + } + } + + String clmProfilesFormatted = clmProfiles != null + ? String.join(",", clmProfiles) + : CLM_PROFILES_NOT_FOUND; + + String eSignProfilesFormatted = eSignProfiles != null + ? String.join(",", eSignProfiles) + : ESIGN_PROFILES_NOT_FOUND; + + products.put(eSignatureProductId, String.format("eSignature - %s", eSignProfilesFormatted)); + products.put(clmProductId, String.format("CLM - %s", clmProfilesFormatted)); + + model.addAttribute("listProducts", products); + + model.addAttribute("emailAddress", emailAddress); + } catch (ApiException e) { + model.addAttribute("emailAddress", null); + } + } else { + model.addAttribute("emailAddress", null); + } + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + UUID existingAccountId = this.getExistingAccountId(this.user.getAccessToken(), this.session.getBasePath(), organizationId); + + ProductPermissionProfilesApi productPermissionProfilesApi = createProductPermissionProfilesApi( + this.user.getAccessToken(), + this.session.getBasePath()); + + //ds-snippet-start:Admin9Step5 + RemoveUserProductsResponse removeUserProductsRepsonse = DeleteUserProductPermissionProfileById.deleteUserProductPermissionProfile( + productPermissionProfilesApi, + args.getProductId(), + this.session.getEmailAddress(), + organizationId, + existingAccountId); + //ds-snippet-end:Admin9Step5 + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(removeUserProductsRepsonse) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } + +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A010DeleteUserDataFromOrganization.java b/src/main/java/com/docusign/controller/admin/examples/A010DeleteUserDataFromOrganization.java new file mode 100644 index 00000000..93bdc002 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A010DeleteUserDataFromOrganization.java @@ -0,0 +1,54 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.OrganizationsApi; +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.model.IndividualUserDataRedactionResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.UserDataManagementService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + +/** + * This example demonstrates how to delete user data from organization. + */ +@Controller +@RequestMapping("/a010") +public class A010DeleteUserDataFromOrganization extends AbstractAdminController { + + @Autowired + public A010DeleteUserDataFromOrganization(DSConfiguration config, User user, Session session) { + super(config, "a010", user, session); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + String accessToken = this.user.getAccessToken(); + String basePath = this.session.getBasePath(); + + UUID organizationId = this.getOrganizationId(accessToken, basePath); + UsersApi usersApi = createUsersApi(accessToken, basePath); + OrganizationsApi organizationsApi = createOrganizationsApi(accessToken, basePath); + + IndividualUserDataRedactionResponse individualUserDataRedactionResponse = (new UserDataManagementService()).deleteUserDataFromOrganizationByEmail( + usersApi, + organizationsApi, + args.getEmail(), + organizationId); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(individualUserDataRedactionResponse) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A011DeleteUserDataFromAccount.java b/src/main/java/com/docusign/controller/admin/examples/A011DeleteUserDataFromAccount.java new file mode 100644 index 00000000..2c054a5f --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A011DeleteUserDataFromAccount.java @@ -0,0 +1,52 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.AccountsApi; +import com.docusign.admin.model.IndividualUserDataRedactionResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.UserDataManagementService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + +/** + * This example demonstrates how to delete user data from account. + */ +@Controller +@RequestMapping("/a011") +public class A011DeleteUserDataFromAccount extends AbstractAdminController { + + @Autowired + public A011DeleteUserDataFromAccount(DSConfiguration config, Session session, User user) { + super(config, "a011", user, session); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + String accessToken = this.user.getAccessToken(); + String basePath = this.session.getBasePath(); + + UUID organizationId = this.getOrganizationId(accessToken, basePath); + UUID existingAccountId = this.getExistingAccountId(accessToken, basePath, organizationId); + AccountsApi accountsApi = createAccountsApi(accessToken, basePath); + + IndividualUserDataRedactionResponse userDataRedactionResponse = (new UserDataManagementService()).deleteUserDataFromAccountByUserId( + accountsApi, + args.getUserId(), + existingAccountId); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(userDataRedactionResponse) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/admin/examples/A012CloneAccount.java b/src/main/java/com/docusign/controller/admin/examples/A012CloneAccount.java new file mode 100644 index 00000000..8a264978 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/A012CloneAccount.java @@ -0,0 +1,65 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.ProvisionAssetGroupApi; +import com.docusign.admin.model.AssetGroupAccountsResponse; +import com.docusign.admin.model.AssetGroupAccountClone; +import com.docusign.common.WorkArguments; +import com.docusign.controller.admin.services.CloneAccountService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.util.UUID; + +/** + * This example demonstrates how to clone the account. + */ +@Controller +@RequestMapping("/a012") +public class A012CloneAccount extends AbstractAdminController { + + @Autowired + public A012CloneAccount(DSConfiguration config, Session session, User user) { + super(config, "a012", user, session); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + UUID organizationId = this.getOrganizationId(this.user.getAccessToken(), this.session.getBasePath()); + ProvisionAssetGroupApi provisionAssetGroupApi = this.createProvisionAssetGroupApi(user.getAccessToken(), session.getBasePath()); + + AssetGroupAccountsResponse groupAccounts = (new CloneAccountService()).getGroupAccounts(provisionAssetGroupApi, organizationId); + model.addAttribute("groups", groupAccounts.getAssetGroupAccounts()); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + String accessToken = this.user.getAccessToken(); + String basePath = this.session.getBasePath(); + UUID organizationId = this.getOrganizationId(accessToken, basePath); + ProvisionAssetGroupApi provisionAssetGroupApi = this.createProvisionAssetGroupApi(accessToken, basePath); + + AssetGroupAccountClone assetGroupAccountClone =(new CloneAccountService()).getClonedAccount( + provisionAssetGroupApi, + organizationId, + args.getSourceAccountId(), + args.getTargetAccountName(), + args.getTargetAccountEmail(), + args.getTargetAccountFirstName(), + args.getTargetAccountLastName()); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(assetGroupAccountClone) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/admin/examples/AbstractAdminController.java b/src/main/java/com/docusign/controller/admin/examples/AbstractAdminController.java new file mode 100644 index 00000000..9f5789cf --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/examples/AbstractAdminController.java @@ -0,0 +1,260 @@ +package com.docusign.controller.admin.examples; + +import com.docusign.DSConfiguration; +import com.docusign.admin.api.*; +import com.docusign.admin.api.UsersApi.GetUserProfilesOptions; +import com.docusign.admin.client.ApiClient; +import com.docusign.admin.client.ApiException; +import com.docusign.admin.model.OrganizationsResponse; +import com.docusign.admin.model.UsersDrilldownResponse; +import com.docusign.core.controller.AbstractController; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.http.HttpHeaders; +import org.springframework.stereotype.Controller; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.UUID; + +/** + * Abstract base class for all Admin controllers. + */ +@Controller +public abstract class AbstractAdminController extends AbstractController { + + private static final Logger LOGGER = LoggerFactory.getLogger(AbstractAdminController.class); + + private static final String EXAMPLE_PAGES_PATH = "pages/admin/examples/"; + + protected final User user; + + protected final Session session; + + private final DSConfiguration configuration; + + + public AbstractAdminController(DSConfiguration config, String exampleName, User user, Session session) { + super(config, exampleName); + this.configuration = config; + this.user = user; + this.session = session; + } + + /** + * Creates new instance of the Admin API client. + * + * @param accessToken user's access token + * @param basePath basePath to the server + * @return an instance of the {@link ApiClient} + */ + protected static ApiClient createApiClient( + String accessToken, + String basePath + ) { + //ds-snippet-start:AdminJavaStep2 + ApiClient apiClient = new ApiClient(basePath); + apiClient.addDefaultHeader( + HttpHeaders.AUTHORIZATION, + BEARER_AUTHENTICATION + accessToken); + //ds-snippet-end:AdminJavaStep2 + + return apiClient; + } + + /** + * Creates a new instance of the UsersApi. This method + * creates an instance of the UsersApi class silently. + * + * @param accessToken user's access token + * @param basePath basePath to the server + * @return an instance of the {@link UsersApi} + */ + protected static UsersApi createUsersApi( + String accessToken, + String basePath + ) { + ApiClient apiClient = createApiClient(accessToken, basePath); + apiClient.addDefaultHeader("Content-Type", "application/json"); + return new UsersApi(apiClient); + } + + /** + * Creates a new instance of the AccountsApi. This method + * creates an instance of the AccountsApi class silently. + * + * @param accessToken user's access token + * @param basePath basePath to the server + * @return an instance of the {@link AccountsApi} + */ + protected static AccountsApi createAccountsApi( + String accessToken, + String basePath + ) { + ApiClient apiClient = createApiClient(accessToken, basePath); + apiClient.addDefaultHeader("Content-Type", "application/json"); + return new AccountsApi(apiClient); + } + + /** + * Creates a new instance of the OrganizationsApi. This method + * creates an instance of the OrganizationsApi class silently. + * + * @param accessToken user's access token + * @param basePath basePath to the server + * @return an instance of the {@link OrganizationsApi} + */ + protected static OrganizationsApi createOrganizationsApi( + String accessToken, + String basePath + ) { + ApiClient apiClient = createApiClient(accessToken, basePath); + apiClient.addDefaultHeader("Content-Type", "application/json"); + return new OrganizationsApi(apiClient); + } + + /** + * Creates a new instance of the BulkExportsApi. This method + * creates an instance of the BulkExportsApi class silently. + * + * @param accessToken user's access token + * @param basePath basePath to the server + * @return an instance of the {@link BulkExportsApi} + */ + protected static BulkExportsApi createBulkExportsApi( + String accessToken, + String basePath + ) { + ApiClient apiClient = createApiClient(accessToken, basePath); + return new BulkExportsApi(apiClient); + } + + /** + * Creates a new instance of the BulkImportsApi. This method + * creates an instance of the BulkImportsApi class silently. + * + * @param accessToken user's access token + * @param basePath basePath to the server + * @return an instance of the {@link BulkImportsApi} + */ + protected static BulkImportsApi createBulkImportsApi( + String accessToken, + String basePath + ) { + ApiClient apiClient = createApiClient(accessToken, basePath); + return new BulkImportsApi(apiClient); + } + + protected String getExamplePagesPath() { + return AbstractAdminController.EXAMPLE_PAGES_PATH; + } + + /** + * Creates a request to get current user. + * + * @param accessToken user's access token + * @param basePath basePath to the server + * @param organizationId the ID of current organization + * @return the account Id + */ + protected UUID getExistingAccountId( + String accessToken, + String basePath, + UUID organizationId + ) throws Exception { + LOGGER.info("createUsers API called"); + UsersApi usersApi = createUsersApi(accessToken, basePath); + LOGGER.info("createUsers called succeeds"); + // set the signer email to get an information about that user + // new GetUsersOptions() will throw "an enclosing instance that contains com.docusign.admin.api.UsersApi.GetUserProfilesOptions is required" + // at compile time. I used this workaround from stackOverflow: + // https://stackoverflow.com/a/4297913/2226328 + LOGGER.info("what email are we feedin ya? hmm??? " + configuration.getSignerEmail()); + GetUserProfilesOptions userProfilesOptions = + usersApi.new GetUserProfilesOptions(); + userProfilesOptions.setEmail(configuration.getSignerEmail()); + LOGGER.info("getUserProfiles called"); + UsersDrilldownResponse user = usersApi.getUserProfiles( + organizationId, + userProfilesOptions + ); + LOGGER.info("getUserProfiles succeeded"); + if (user.getUsers().isEmpty()) { + throw new Exception("Could not get an account id from the request."); + } + + return user.getUsers().get(0).getDefaultAccountId(); + } + + protected UUID getOrganizationId(String accessToken, String basePath) + throws ApiException { + UUID orgId = null; + if (session.getOrgId() == null) { + + ApiClient apiClient = createApiClient(accessToken, basePath); + AccountsApi accounts = new AccountsApi(apiClient); + LOGGER.info("before Org id"); + OrganizationsResponse orgs = accounts.getOrganizations(); + LOGGER.info("after orgs call"); + if (orgs.getOrganizations().isEmpty()) { + throw new ApiException( + "No organizations found on this account, please create an organization first." + ); + } else { + LOGGER.info("we're looking for a specific org id"); + orgId = orgs.getOrganizations().get(0).getId(); + LOGGER.info("first found org id is: " + orgId); + session.setOrgId(orgId); + } + + } else { + LOGGER.info("nothing found? try a 2nd way"); + orgId = session.getOrgId(); + + LOGGER.info("we have an org id: " + orgId); + } + + return orgId; + } + + /** + * Creates a new instance of the ProductPermissionProfilesApi. This method + * creates an instance of the ProductPermissionProfilesApi class silently. + * @param accessToken user's access token + * @param basePath basePath to the server + * @return an instance of the {@link ProductPermissionProfilesApi} + */ + protected ProductPermissionProfilesApi createProductPermissionProfilesApi( + String accessToken, + String basePath + ) { + ApiClient apiClient = createApiClient(accessToken, basePath); + return new ProductPermissionProfilesApi(apiClient); + } + + /** + * Creates a new instance of the AdminGroupsApi. This method + * creates an instance of the AdminGroupsApi class silently. + * @param accessToken user's access token + * @param basePath basePath to the server + * @return an instance of the {@link DsGroupsApi} + */ + protected DsGroupsApi createDSGroupsApi(String accessToken, String basePath) { + ApiClient apiClient = createApiClient(accessToken, basePath); + return new DsGroupsApi(apiClient); + } + + /** + * Creates a new instance of the ProvisionAssetGroupApi. This method + * creates an instance of the ProvisionAssetGroupApi class silently. + * @param accessToken user's access token + * @param basePath basePath to the server + * @return an instance of the {@link ProvisionAssetGroupApi} + */ + protected ProvisionAssetGroupApi createProvisionAssetGroupApi(String accessToken, String basePath) { + //ds-snippet-start:Admin12Step2 + ApiClient apiClient = createApiClient(accessToken, basePath); + return new ProvisionAssetGroupApi(apiClient); + //ds-snippet-end:Admin12Step2 + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/AddActiveUserService.java b/src/main/java/com/docusign/controller/admin/services/AddActiveUserService.java new file mode 100644 index 00000000..290d3404 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/AddActiveUserService.java @@ -0,0 +1,48 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.model.*; + +import java.util.ArrayList; +import java.util.UUID; + +public class AddActiveUserService { + //ds-snippet-start:Admin1Step5 + public static NewUserResponse createNewActiveUser( + String groupId, + String profileId, + String email, + String userName, + String firstName, + String lastName, + UsersApi usersApi, + UUID organizationId, + UUID accountId) throws Exception + { + java.util.List groups = new ArrayList<>(); + groups.add(new GroupRequest().id(Long.valueOf(groupId))); + + // Fill the request with data from the form + NewUserRequest accountUserRequest = new NewUserRequest() + .defaultAccountId(accountId) + .addAccountsItem( + new NewUserRequestAccountProperties() + .id(accountId) + .permissionProfile( + new PermissionProfileRequest() + .id(Long.valueOf(profileId)) + ) + .groups(groups) + ) + .email(email) + .userName(userName) + .firstName(firstName) + .lastName(lastName) + .autoActivateMemberships(true); + //ds-snippet-end:Admin1Step5 + + //ds-snippet-start:Admin1Step6 + return usersApi.createUser(organizationId, accountUserRequest); + //ds-snippet-end:Admin1Step6 + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/AuditUsersService.java b/src/main/java/com/docusign/controller/admin/services/AuditUsersService.java new file mode 100644 index 00000000..f379b4c9 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/AuditUsersService.java @@ -0,0 +1,56 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.client.ApiException; +import com.docusign.admin.model.OrganizationUserResponse; +import com.docusign.admin.model.OrganizationUsersResponse; +import com.docusign.admin.model.UserDrilldownResponse; +import com.docusign.admin.model.UsersDrilldownResponse; + +import java.text.SimpleDateFormat; +import java.util.ArrayList; +import java.util.Date; +import java.util.TimeZone; +import java.util.UUID; + +public class AuditUsersService { + private static final String timeZoneId = "UTC"; + + private static final String simpleDateFormat = "yyyy-MM-dd'T'HH:mm'Z'"; + + public static ArrayList auditUsers( + UsersApi usersApi, + UUID organizationId, + UUID accountId + ) throws ApiException { + ArrayList auditedUsers = new ArrayList<>(); + + //ds-snippet-start:Admin5Step3 + UsersApi.GetUsersOptions options = usersApi.new GetUsersOptions(); + options.setAccountId(accountId); + TimeZone tz = TimeZone.getTimeZone(timeZoneId); + SimpleDateFormat df = new SimpleDateFormat(simpleDateFormat); + // Quoted "Z" to indicate UTC, no timezone offset + df.setTimeZone(tz); + Integer tenDaysBeforeToday = 1000 * 60 * 60 * 24 * 10; + String nowAsISO = df.format(new Date(System.currentTimeMillis() - tenDaysBeforeToday)); + options.setLastModifiedSince(nowAsISO); + OrganizationUsersResponse modifiedUsers = usersApi.getUsers(organizationId, options); + //ds-snippet-end:Admin5Step3 + + //ds-snippet-start:Admin5Step5 + for (OrganizationUserResponse user : modifiedUsers.getUsers()) { + //ds-snippet-end:Admin5Step5 + //ds-snippet-start:Admin5Step4 + UsersApi.GetUserProfilesOptions profilesOptions = usersApi.new GetUserProfilesOptions(); + profilesOptions.setEmail(user.getEmail()); + //ds-snippet-end:Admin5Step4 + //ds-snippet-start:Admin5Step5 + UsersDrilldownResponse res = usersApi.getUserProfiles(organizationId, profilesOptions); + auditedUsers.add(res.getUsers().get(0)); + } + //ds-snippet-end:Admin5Step5 + + return auditedUsers; + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/BulkExportUserDataService.java b/src/main/java/com/docusign/controller/admin/services/BulkExportUserDataService.java new file mode 100644 index 00000000..0e51041a --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/BulkExportUserDataService.java @@ -0,0 +1,90 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.BulkExportsApi; +import com.docusign.admin.client.ApiException; +import com.docusign.admin.model.OrganizationExportRequest; +import com.docusign.admin.model.OrganizationExportResponse; +import com.docusign.admin.model.OrganizationExportsResponse; +import jakarta.ws.rs.core.MediaType; +import org.apache.commons.io.FileUtils; +import org.apache.commons.lang3.StringUtils; +import org.springframework.http.HttpHeaders; + +import javax.net.ssl.HttpsURLConnection; +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.file.Paths; +import java.util.Objects; +import java.util.UUID; + +public class BulkExportUserDataService { + public static OrganizationExportsResponse bulkExportsUserData( + BulkExportsApi bulkExportsApi, + UUID organizationId) throws ApiException { + return bulkExportsApi.getUserListExports(organizationId); + } + + public static OrganizationExportResponse bulkExportUserData( + BulkExportsApi bulkExportsApi, + UUID organizationId, + UUID exportId) throws ApiException { + return bulkExportsApi.getUserListExport(organizationId, exportId); + } + + public static OrganizationExportResponse createUserListExport( + BulkExportsApi bulkExportsApi, + UUID organizationId) throws ApiException { + OrganizationExportRequest request = new OrganizationExportRequest(); + request.setType("organization_memberships_export"); + return bulkExportsApi.createUserListExport(organizationId, request); + } + + public static String moveUserListExportToFile( + String csvUri, + String bearerAuthentication, + String accessToken, + Integer bufferSize) throws IOException, URISyntaxException { + //ds-snippet-start:Admin3Step5 + URL request_url = new URL(csvUri); + + // Send Web request to download and save the exported CSV data + HttpsURLConnection.setFollowRedirects(true); // Defaults to true + HttpsURLConnection http_conn = (HttpsURLConnection) request_url.openConnection(); + http_conn.setRequestProperty(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON); + http_conn.setRequestProperty(HttpHeaders.CONTENT_TYPE, "mutlipart/form-data"); + http_conn.setRequestProperty(HttpHeaders.AUTHORIZATION, bearerAuthentication + accessToken); + http_conn.setInstanceFollowRedirects(true); + + ClassLoader rawPath = Thread.currentThread().getContextClassLoader(); + String rootDir = Paths.get(Objects.requireNonNull(rawPath.getResource("")).toURI()).toString(); + // Set the save file path in the project root instead of the compiled folder and + // force forward slash scheme + rootDir = StringUtils.remove(rootDir, "target\\classes"); + rootDir = StringUtils.remove(rootDir, "file:/"); + rootDir = StringUtils.replace(rootDir, "\\", "/"); + + // opens input stream from the HTTP connection + InputStream inputStream = http_conn.getInputStream(); + String saveFilePath = rootDir + "src/main/resources/ExportedUserData.csv"; + + // opens an output stream to save into file + FileOutputStream outputStream = FileUtils.openOutputStream(new File(saveFilePath)); + + int bytesRead; + byte[] buffer = new byte[bufferSize]; + while ((bytesRead = inputStream.read(buffer)) != -1) { + outputStream.write(buffer, 0, bytesRead); + } + + outputStream.close(); + inputStream.close(); + http_conn.disconnect(); + //ds-snippet-end:Admin3Step5 + + return saveFilePath; + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/BulkImportUserDataService.java b/src/main/java/com/docusign/controller/admin/services/BulkImportUserDataService.java new file mode 100644 index 00000000..59e5f510 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/BulkImportUserDataService.java @@ -0,0 +1,25 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.BulkImportsApi; +import com.docusign.admin.model.OrganizationImportResponse; + +import java.nio.charset.StandardCharsets; +import java.util.UUID; + +public class BulkImportUserDataService { + private static final String BULK_IMPORT_TEXT = "AccountID,UserName,UserEmail,PermissionSet\n%s,FirstLast1,User1java@example.com,DS Admin\n%s,FirstLast2,User2java@example.com,DS Sender"; + + public static OrganizationImportResponse bulkImportUserData( + BulkImportsApi bulkImportsApi, + UUID organizationId, + UUID accountId + ) throws Exception { + // Make sure you're using a verified domain for auto-activation to work properly + //ds-snippet-start:Admin4Step3 + String csvUserData = String.format(BULK_IMPORT_TEXT, accountId, accountId); + byte[] csvDataInBytes = csvUserData.getBytes(StandardCharsets.UTF_8); + + return bulkImportsApi.createBulkImportSingleAccountAddUsersRequest(organizationId, accountId, csvDataInBytes); + //ds-snippet-end:Admin4Step3 + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/CheckImportRequestStatusService.java b/src/main/java/com/docusign/controller/admin/services/CheckImportRequestStatusService.java new file mode 100644 index 00000000..2674e9a9 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/CheckImportRequestStatusService.java @@ -0,0 +1,18 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.BulkImportsApi; +import com.docusign.admin.model.OrganizationImportResponse; + +import java.util.UUID; + +public class CheckImportRequestStatusService { + public static OrganizationImportResponse checkRequestStatus( + BulkImportsApi bulkImportsApi, + UUID organizationId, + UUID importId + ) throws Exception { + // Step 4a start + return bulkImportsApi.getBulkUserImportRequest(organizationId, importId); + // Step 4a end + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/CheckRequestStatusService.java b/src/main/java/com/docusign/controller/admin/services/CheckRequestStatusService.java new file mode 100644 index 00000000..55cc39e5 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/CheckRequestStatusService.java @@ -0,0 +1,16 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.BulkExportsApi; +import com.docusign.admin.model.OrganizationExportResponse; + +import java.util.UUID; + +public class CheckRequestStatusService { + public static OrganizationExportResponse checkRequestStatus( + BulkExportsApi bulkExportsApi, + UUID organizationId, + UUID exportId + ) throws Exception { + return bulkExportsApi.getUserListExport(organizationId, exportId); + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/CloneAccountService.java b/src/main/java/com/docusign/controller/admin/services/CloneAccountService.java new file mode 100644 index 00000000..fb79426d --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/CloneAccountService.java @@ -0,0 +1,60 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.ProvisionAssetGroupApi; +import com.docusign.admin.client.ApiException; +import com.docusign.admin.model.AssetGroupAccountClone; +import com.docusign.admin.model.AssetGroupAccountsResponse; +import com.docusign.admin.model.AssetGroupAccountCloneSourceAccount; +import com.docusign.admin.model.AssetGroupAccountCloneTargetAccount; +import com.docusign.admin.model.AssetGroupAccountCloneTargetAccountAdmin; + +import java.util.UUID; + +public class CloneAccountService { + public AssetGroupAccountsResponse getGroupAccounts( + ProvisionAssetGroupApi provisionAssetGroupApi, + UUID organizationId + ) throws ApiException { + + //ds-snippet-start:Admin12Step3 + ProvisionAssetGroupApi.GetAssetGroupAccountsOptions options = provisionAssetGroupApi.new GetAssetGroupAccountsOptions(); + options.setCompliant(true); + return provisionAssetGroupApi.getAssetGroupAccounts(organizationId, options); + //ds-snippet-end:Admin12Step3 + } + + public AssetGroupAccountClone getClonedAccount( + ProvisionAssetGroupApi provisionAssetGroupApi, + UUID organizationId, + UUID sourceAccountId, + String targetAccountName, + String targetAccountEmail, + String targetAccountFirstName, + String targetAccountLastName + ) throws ApiException { + //ds-snippet-start:Admin12Step4 + String countryCode = "US"; + + AssetGroupAccountClone accountData = new AssetGroupAccountClone(); + AssetGroupAccountCloneSourceAccount sourceAccount = new AssetGroupAccountCloneSourceAccount(); + sourceAccount.setId(sourceAccountId); + + AssetGroupAccountCloneTargetAccount targetAccount = new AssetGroupAccountCloneTargetAccount(); + targetAccount.setName(targetAccountName); + targetAccount.setCountryCode(countryCode); + + AssetGroupAccountCloneTargetAccountAdmin admin = new AssetGroupAccountCloneTargetAccountAdmin(); + admin.setEmail(targetAccountEmail); + admin.setFirstName(targetAccountFirstName); + admin.setLastName(targetAccountLastName); + + targetAccount.admin(admin); + accountData.setSourceAccount(sourceAccount); + accountData.setTargetAccount(targetAccount); + //ds-snippet-end:Admin12Step4 + + //ds-snippet-start:Admin12Step5 + return provisionAssetGroupApi.cloneAssetGroupAccount(organizationId, accountData); + //ds-snippet-end:Admin12Step5 + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/CreateActiveCLMESignUserService.java b/src/main/java/com/docusign/controller/admin/services/CreateActiveCLMESignUserService.java new file mode 100644 index 00000000..8386ee33 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/CreateActiveCLMESignUserService.java @@ -0,0 +1,55 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.model.AddUserResponse; +import com.docusign.admin.model.DSGroupRequest; +import com.docusign.admin.model.NewMultiProductUserAddRequest; +import com.docusign.admin.model.ProductPermissionProfileRequest; + +import java.util.UUID; + +public class CreateActiveCLMESignUserService { + public static AddUserResponse createNewActiveUser( + String clmProfileId, + UUID clmProductId, + String eSignProfileId, + UUID eSignProductId, + UUID dsGroupId, + String userName, + String firstName, + String lastName, + String email, + UsersApi usersApi, + UUID organizationId, + UUID accountId + ) throws Exception { + //ds-snippet-start:Admin2Step5 + ProductPermissionProfileRequest clm = new ProductPermissionProfileRequest(); + ProductPermissionProfileRequest eSign = new ProductPermissionProfileRequest(); + clm.setPermissionProfileId(clmProfileId); + clm.setProductId(clmProductId); + + eSign.setPermissionProfileId(eSignProfileId); + eSign.setProductId(eSignProductId); + + DSGroupRequest dsGroup = new DSGroupRequest(); + dsGroup.setDsGroupId(dsGroupId); + // Fill the request with data from the form + + NewMultiProductUserAddRequest multiProductUserAddRequest = new NewMultiProductUserAddRequest() + .defaultAccountId(accountId) + .addProductPermissionProfilesItem(clm) + .addProductPermissionProfilesItem(eSign) + .addDsGroupsItem(dsGroup) + .userName(userName) + .firstName(firstName) + .lastName(lastName) + .autoActivateMemberships(true) + .email(email); + //ds-snippet-end:Admin2Step5 + + //ds-snippet-start:Admin2Step6 + return usersApi.addOrUpdateUser(organizationId, accountId, multiProductUserAddRequest); + //ds-snippet-end:Admin2Step6 + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/DeleteUserProductPermissionProfileById.java b/src/main/java/com/docusign/controller/admin/services/DeleteUserProductPermissionProfileById.java new file mode 100644 index 00000000..80f5c66a --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/DeleteUserProductPermissionProfileById.java @@ -0,0 +1,30 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.ProductPermissionProfilesApi; +import com.docusign.admin.model.RemoveUserProductsResponse; +import com.docusign.admin.model.UserProductProfileDeleteRequest; + +import java.util.Collections; +import java.util.UUID; + +public class DeleteUserProductPermissionProfileById { + public static RemoveUserProductsResponse deleteUserProductPermissionProfile( + ProductPermissionProfilesApi productPermissionProfilesApi, + UUID productId, + String emailAddress, + UUID organizationId, + UUID accountId + ) throws Exception { + + //ds-snippet-start:Admin9Step4 + var userProductProfileDeleteRequest = new UserProductProfileDeleteRequest(); + userProductProfileDeleteRequest.setProductIds(Collections.singletonList(productId)); + userProductProfileDeleteRequest.setUserEmail(emailAddress); + //ds-snippet-end:Admin9Step4 + + return productPermissionProfilesApi.removeUserProductPermission( + organizationId, + accountId, + userProductProfileDeleteRequest); + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/controller/admin/services/RetrieveDocuSignProfileByEmailAddress.java b/src/main/java/com/docusign/controller/admin/services/RetrieveDocuSignProfileByEmailAddress.java new file mode 100644 index 00000000..b9251230 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/RetrieveDocuSignProfileByEmailAddress.java @@ -0,0 +1,18 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.model.UsersDrilldownResponse; + +import java.util.UUID; + +public class RetrieveDocuSignProfileByEmailAddress { + public static UsersDrilldownResponse getDocuSignProfileByEmailAddress( + UsersApi usersApi, + UUID organizationId, + String emailAddress + ) throws Exception { + var userOptions = usersApi.new GetUserDSProfilesByEmailOptions(); + userOptions.setEmail(emailAddress); + return usersApi.getUserDSProfilesByEmail(organizationId, userOptions); + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/RetrieveDocuSignProfileByUserId.java b/src/main/java/com/docusign/controller/admin/services/RetrieveDocuSignProfileByUserId.java new file mode 100644 index 00000000..a54e8256 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/RetrieveDocuSignProfileByUserId.java @@ -0,0 +1,16 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.model.UsersDrilldownResponse; + +import java.util.UUID; + +public class RetrieveDocuSignProfileByUserId { + public static UsersDrilldownResponse getDocuSignProfileByUserId( + UsersApi usersApi, + UUID organizationId, + UUID userId + ) throws Exception { + return usersApi.getUserDSProfile(organizationId, userId); + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/UpdateUserProductPermissionProfileByEmail.java b/src/main/java/com/docusign/controller/admin/services/UpdateUserProductPermissionProfileByEmail.java new file mode 100644 index 00000000..f00bc903 --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/UpdateUserProductPermissionProfileByEmail.java @@ -0,0 +1,36 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.ProductPermissionProfilesApi; +import com.docusign.admin.model.ProductPermissionProfileRequest; +import com.docusign.admin.model.UserProductPermissionProfilesRequest; +import com.docusign.admin.model.UserProductPermissionProfilesResponse; + +import java.util.UUID; + +public class UpdateUserProductPermissionProfileByEmail { + public static UserProductPermissionProfilesResponse updateUserProductPermissionProfile( + ProductPermissionProfilesApi productPermissionProfilesApi, + String permissionProfileId, + UUID productId, + String emailAddress, + UUID organizationId, + UUID accountId + ) throws Exception { + //ds-snippet-start:Admin8Step3 + var productPermissionProfileRequest = new ProductPermissionProfileRequest(); + productPermissionProfileRequest.setPermissionProfileId(permissionProfileId); + productPermissionProfileRequest.setProductId(productId); + + var userProductPermissionProfilesRequest = new UserProductPermissionProfilesRequest(); + userProductPermissionProfilesRequest.email(emailAddress); + userProductPermissionProfilesRequest.addProductPermissionProfilesItem(productPermissionProfileRequest); + //ds-snippet-end:Admin8Step3 + + //ds-snippet-start:Admin8Step4 + return productPermissionProfilesApi.addUserProductPermissionProfilesByEmail( + organizationId, + accountId, + userProductPermissionProfilesRequest); + //ds-snippet-end:Admin8Step4 + } +} diff --git a/src/main/java/com/docusign/controller/admin/services/UserDataManagementService.java b/src/main/java/com/docusign/controller/admin/services/UserDataManagementService.java new file mode 100644 index 00000000..e06e4b4c --- /dev/null +++ b/src/main/java/com/docusign/controller/admin/services/UserDataManagementService.java @@ -0,0 +1,64 @@ +package com.docusign.controller.admin.services; + +import com.docusign.admin.api.AccountsApi; +import com.docusign.admin.api.OrganizationsApi; +import com.docusign.admin.api.UsersApi; +import com.docusign.admin.client.ApiException; +import com.docusign.admin.model.IndividualMembershipDataRedactionRequest; +import com.docusign.admin.model.IndividualUserDataRedactionResponse; +import com.docusign.admin.model.UserDrilldownResponse; +import com.docusign.admin.model.UsersDrilldownResponse; +import com.docusign.admin.model.MembershipDataRedactionRequest; +import com.docusign.admin.model.IndividualUserDataRedactionRequest; + +import java.util.Arrays; +import java.util.List; +import java.util.UUID; + +public class UserDataManagementService { + public IndividualUserDataRedactionResponse deleteUserDataFromAccountByUserId( + AccountsApi accountsApi, + UUID userId, + UUID accountId + ) throws Exception { + //ds-snippet-start:Admin11Step3 + IndividualMembershipDataRedactionRequest membershipDataRedaction = new IndividualMembershipDataRedactionRequest(); + membershipDataRedaction.userId(userId); + //ds-snippet-end:Admin11Step3 + //ds-snippet-start:Admin11Step4 + return accountsApi.redactIndividualMembershipData(accountId, membershipDataRedaction); + //ds-snippet-end:Admin11Step4 + } + + public IndividualUserDataRedactionResponse deleteUserDataFromOrganizationByEmail( + UsersApi usersApi, + OrganizationsApi organizationsApi, + String emailAddress, + UUID organizationId + ) throws ApiException { + UsersApi.GetUserDSProfilesByEmailOptions getProfilesOptions = usersApi.new GetUserDSProfilesByEmailOptions(); + getProfilesOptions.setEmail(emailAddress); + + UsersDrilldownResponse profiles = usersApi.getUserDSProfilesByEmail(organizationId, getProfilesOptions); + + UserDrilldownResponse user = null; + if (profiles.getUsers() != null && !profiles.getUsers().isEmpty() && profiles.getUsers().get(0) != null) { + user = profiles.getUsers().get(0); + } + + MembershipDataRedactionRequest memberships = new MembershipDataRedactionRequest(); + + if (user.getMemberships() != null && !user.getMemberships().isEmpty() && user.getMemberships().get(0) != null) { + memberships.accountId(user.getMemberships().get(0).getAccountId()); + } + + //ds-snippet-start:Admin10Step3 + IndividualUserDataRedactionRequest userRedactionRequest = new IndividualUserDataRedactionRequest(); + userRedactionRequest.setUserId(user.getId()); + userRedactionRequest.setMemberships(Arrays.asList(memberships)); + //ds-snippet-end:Admin10Step3 + //ds-snippet-start:Admin10Step4 + return organizationsApi.redactIndividualUserData(organizationId, userRedactionRequest); + //ds-snippet-end:Admin10Step4 + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/controller/click/examples/AbstractClickController.java b/src/main/java/com/docusign/controller/click/examples/AbstractClickController.java new file mode 100644 index 00000000..7ed28f22 --- /dev/null +++ b/src/main/java/com/docusign/controller/click/examples/AbstractClickController.java @@ -0,0 +1,56 @@ +package com.docusign.controller.click.examples; + +import com.docusign.DSConfiguration; +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiClient; +import com.docusign.click.client.auth.OAuth; +import com.docusign.core.controller.AbstractController; +import org.springframework.http.HttpHeaders; +import org.springframework.stereotype.Controller; + +/** + * Abstract base class for all Click controllers. + */ +@Controller +public abstract class AbstractClickController extends AbstractController { + + private static final String EXAMPLE_PAGES_PATH = "pages/click/examples/"; + + public AbstractClickController(DSConfiguration config, String exampleName) { + super(config, exampleName); + } + + /** + * Creates new instance of the Click API client. + * + * @param basePath URL to Click REST API + * @param userAccessToken user's access token + * @return an instance of the {@link ApiClient} + */ + protected static ApiClient createApiClient(String basePath, String userAccessToken) { + //ds-snippet-start:ClickJavaStep2 + ApiClient apiClient = new ApiClient(basePath); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + userAccessToken); + apiClient.addAuthorization("docusignAccessCode", new OAuth()); + return apiClient; + //ds-snippet-end:ClickJavaStep2 + } + + /** + * Creates a new instance of the ClickApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to Click REST API + * @param userAccessToken user's access token + * @return an instance of the {@link AccountsApi} + */ + protected static AccountsApi createAccountsApiClient(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new AccountsApi(apiClient); + } + + protected String getExamplePagesPath() { + return AbstractClickController.EXAMPLE_PAGES_PATH; + } +} + diff --git a/src/main/java/com/docusign/controller/click/examples/C001ControllerCreateClickwrap.java b/src/main/java/com/docusign/controller/click/examples/C001ControllerCreateClickwrap.java new file mode 100644 index 00000000..5d7acf5e --- /dev/null +++ b/src/main/java/com/docusign/controller/click/examples/C001ControllerCreateClickwrap.java @@ -0,0 +1,77 @@ +package com.docusign.controller.click.examples; + +import com.docusign.DSConfiguration; +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapRequest; +import com.docusign.click.model.ClickwrapVersionSummaryResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.click.services.CreateClickwrapService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * Create a clickwrap. + */ +@Controller +@RequestMapping("/c001") +public class C001ControllerCreateClickwrap extends AbstractClickController { + + private static final String DOCUMENT_FILE_NAME = "TermsOfService.pdf"; + + private static final Integer DOCUMENT_ORDER = 0; + + private static final String DOCUMENT_NAME = "Terms of Service"; + + private final Session session; + + private final User user; + + @Autowired + public C001ControllerCreateClickwrap(DSConfiguration config, Session session, User user) { + super(config, "c001"); + this.session = session; + this.user = user; + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + // Step 2. Construct your API headers + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + + // Step 3. Construct the request body for your clickwrap + //ds-snippet-start:Click1Step3 + ClickwrapRequest clickwrapRequest = CreateClickwrapService.createClickwrapRequest( + args.getClickwrapName(), + DOCUMENT_FILE_NAME, + DOCUMENT_NAME, + DOCUMENT_ORDER); + //ds-snippet-end:Click1Step3 + + // Step 4. Call the v1 Click API + //ds-snippet-start:Click1Step4 + ClickwrapVersionSummaryResponse createdClickwrap = CreateClickwrapService.createClickwrap( + accountsApi, + this.session.getAccountId(), + clickwrapRequest); + //ds-snippet-end:Click1Step4 + + this.session.setClickwrapId(createdClickwrap.getClickwrapId()); + this.session.setClickwrapVersionNumber(createdClickwrap.getVersionNumber()); + DoneExample.createDefault(this.title) + .withJsonObject(createdClickwrap) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText.replaceFirst("\\{0}", createdClickwrap.getClickwrapName())) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/click/examples/C002ControllerActivateClickwrap.java b/src/main/java/com/docusign/controller/click/examples/C002ControllerActivateClickwrap.java new file mode 100644 index 00000000..418a6759 --- /dev/null +++ b/src/main/java/com/docusign/controller/click/examples/C002ControllerActivateClickwrap.java @@ -0,0 +1,80 @@ +package com.docusign.controller.click.examples; + +import com.docusign.DSConfiguration; +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapVersionSummaryResponse; +import com.docusign.click.model.ClickwrapVersionsResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.click.services.ActivateClickwrapService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; + +/** + * Activate a clickwrap. + */ +@Controller +@RequestMapping("/c002") +public class C002ControllerActivateClickwrap extends AbstractClickController { + + private static final String MODEL_CLICKWRAPS = "clickwraps"; + + private final Session session; + + private final User user; + + @Autowired + public C002ControllerActivateClickwrap(DSConfiguration config, Session session, User user) { + super(config, "c002"); + this.session = session; + this.user = user; + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + ClickwrapVersionsResponse inactiveClickwraps = ActivateClickwrapService.getClickwrapsByStatus( + accountsApi, + this.session.getAccountId(), + "inactive"); + ClickwrapVersionsResponse draftClickwraps = ActivateClickwrapService.getClickwrapsByStatus( + accountsApi, + this.session.getAccountId(), + "draft"); + inactiveClickwraps.getClickwraps().addAll(draftClickwraps.getClickwraps()); + model.addAttribute(MODEL_CLICKWRAPS, inactiveClickwraps); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException { + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + + String clickwrap = args.getClickwrap(); + String[] clickwrapData = clickwrap.split(":"); + String clickwrapId = clickwrapData[0]; + String versionNumber = clickwrapData[1]; + + ClickwrapVersionSummaryResponse updatedClickwrap = ActivateClickwrapService.activateClickwrap( + accountsApi, + this.session.getAccountId(), + clickwrapId, + versionNumber); + + DoneExample.createDefault(this.title) + .withJsonObject(updatedClickwrap) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/click/examples/C003ControllerCreateNewVersionClickwrap.java b/src/main/java/com/docusign/controller/click/examples/C003ControllerCreateNewVersionClickwrap.java new file mode 100644 index 00000000..40826fc2 --- /dev/null +++ b/src/main/java/com/docusign/controller/click/examples/C003ControllerCreateNewVersionClickwrap.java @@ -0,0 +1,81 @@ +package com.docusign.controller.click.examples; + +import com.docusign.DSConfiguration; +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapVersionSummaryResponse; +import com.docusign.click.model.ClickwrapVersionsResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.click.services.CreateNewVersionClickwrapService; +import com.docusign.controller.click.services.GetListClickwrapsService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * Create a clickwrap. + */ +@Controller +@RequestMapping("/c003") +public class C003ControllerCreateNewVersionClickwrap extends AbstractClickController { + + private static final String MODEL_CLICKWRAPS = "clickwraps"; + + private static final String DOCUMENT_FILE_NAME = "TermsOfService.pdf"; + + private static final Integer DOCUMENT_ORDER = 0; + + private static final String DOCUMENT_NAME = "Terms of Service"; + + private final Session session; + + private final User user; + + @Autowired + public C003ControllerCreateNewVersionClickwrap(DSConfiguration config, Session session, User user) { + super(config, "c003"); + this.session = session; + this.user = user; + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + ClickwrapVersionsResponse clickwraps = GetListClickwrapsService.getListClickwrap(accountsApi, this.session.getAccountId()); + model.addAttribute(MODEL_CLICKWRAPS, clickwraps); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + // Step 2: Construct your API headers + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + + ClickwrapVersionSummaryResponse createdClickwrap = CreateNewVersionClickwrapService.createNewVersionClickwrap( + accountsApi, + CreateNewVersionClickwrapService.createClickwrapRequest(DOCUMENT_FILE_NAME, DOCUMENT_NAME, DOCUMENT_ORDER, args.getClickwrapName()), + this.session.getAccountId(), + args.getClickwrapId() + ); + + this.session.setClickwrapId(createdClickwrap.getClickwrapId()); + this.session.setClickwrapVersionNumber(createdClickwrap.getVersionNumber()); + DoneExample.createDefault(this.title) + .withJsonObject(createdClickwrap) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", createdClickwrap.getVersionNumber()) + .replaceFirst("\\{1}", createdClickwrap.getClickwrapName())) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/click/examples/C004ControllerGetListClickwraps.java b/src/main/java/com/docusign/controller/click/examples/C004ControllerGetListClickwraps.java new file mode 100644 index 00000000..f9d9e65b --- /dev/null +++ b/src/main/java/com/docusign/controller/click/examples/C004ControllerGetListClickwraps.java @@ -0,0 +1,53 @@ +package com.docusign.controller.click.examples; + +import com.docusign.DSConfiguration; +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapVersionsResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.click.services.GetListClickwrapsService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; + +/** + * Get a list of clickwraps. + */ +@Controller +@RequestMapping("/c004") +public class C004ControllerGetListClickwraps extends AbstractClickController { + + private final Session session; + + private final User user; + + @Autowired + public C004ControllerGetListClickwraps(DSConfiguration config, Session session, User user) { + super(config, "c004"); + this.session = session; + this.user = user; + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException { + // Step 2: Construct your API headers + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + + ClickwrapVersionsResponse clickwrapsResponse = GetListClickwrapsService.getListClickwrap( + accountsApi, + this.session.getAccountId()); + + DoneExample.createDefault(this.title) + .withJsonObject(clickwrapsResponse) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/click/examples/C005ControllerGetClickwrapResponses.java b/src/main/java/com/docusign/controller/click/examples/C005ControllerGetClickwrapResponses.java new file mode 100644 index 00000000..742b8caf --- /dev/null +++ b/src/main/java/com/docusign/controller/click/examples/C005ControllerGetClickwrapResponses.java @@ -0,0 +1,70 @@ +package com.docusign.controller.click.examples; + +import com.docusign.DSConfiguration; +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapAgreementsResponse; +import com.docusign.click.model.ClickwrapVersionsResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.click.services.GetClickwrapResponsesService; +import com.docusign.controller.click.services.GetListClickwrapsService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; + +/** + * Get clickwrap responses. + */ +@Controller +@RequestMapping("/c005") +public class C005ControllerGetClickwrapResponses extends AbstractClickController { + + private static final String MODEL_CLICKWRAPS = "clickwraps"; + + private final Session session; + + private final User user; + + @Autowired + public C005ControllerGetClickwrapResponses(DSConfiguration config, Session session, User user) { + super(config, "c005"); + this.session = session; + this.user = user; + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + ClickwrapVersionsResponse clickwraps = GetListClickwrapsService.getListClickwrap(accountsApi, this.session.getAccountId()); + model.addAttribute(MODEL_CLICKWRAPS, clickwraps); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException { + // Step 2: Construct your API headers + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + + // Step 3: Call the v1 Click API + //ds-snippet-start:Click5Step3 + ClickwrapAgreementsResponse clickwrapAgreementsResponse = GetClickwrapResponsesService.getClickwrapResponses( + accountsApi, + this.session.getAccountId(), + args.getClickwrapId()); + //ds-snippet-end:Click5Step3 + + DoneExample.createDefault(this.title) + .withJsonObject(clickwrapAgreementsResponse) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/click/examples/C006ControllerEmbedClickwrap.java b/src/main/java/com/docusign/controller/click/examples/C006ControllerEmbedClickwrap.java new file mode 100644 index 00000000..604f3a4e --- /dev/null +++ b/src/main/java/com/docusign/controller/click/examples/C006ControllerEmbedClickwrap.java @@ -0,0 +1,87 @@ +package com.docusign.controller.click.examples; + +import com.docusign.DSConfiguration; +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapVersionsResponse; +import com.docusign.common.WorkArguments; +import com.docusign.controller.click.services.ActivateClickwrapService; +import com.docusign.controller.click.services.EmbedClickwrapService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; + +/** + * Activate a clickwrap. + */ +@Controller +@RequestMapping("/c006") +public class C006ControllerEmbedClickwrap extends AbstractClickController { + + private static final String MODEL_CLICKWRAPS = "clickwraps"; + + private final Session session; + + private final User user; + + @Autowired + public C006ControllerEmbedClickwrap(DSConfiguration config, Session session, User user) { + super(config, "c006"); + this.session = session; + this.user = user; + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + ClickwrapVersionsResponse clickwraps = EmbedClickwrapService.getActiveClickwraps(accountsApi, this.session.getAccountId()); + ClickwrapVersionsResponse inactiveClickwraps = ActivateClickwrapService.getClickwrapsByStatus(accountsApi, this.session.getAccountId(), "inactive"); + Boolean hasInactiveClickraps = inactiveClickwraps.getClickwraps().size() > 0; + model.addAttribute(MODEL_CLICKWRAPS, clickwraps); + model.addAttribute("hasInactiveClickraps", hasInactiveClickraps); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException { + // Step 2: Construct your API headers + AccountsApi accountsApi = createAccountsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + + String clickwrapId = args.getClickwrap(); + String fullName = args.getFullName(); + String email = args.getEmail(); + String company = args.getCompany(); + String title = args.getTitle(); + String date = args.getDate(); + + String url = EmbedClickwrapService.createAgreementUrl( + accountsApi, this.session.getAccountId(), + clickwrapId, fullName, email, company, title, date); + + if (url == "Already Agreed") { + new DoneExample() + .withTitle(exampleName) + .withName(title) + .withMessage("The email address was already used to agree to this elastic template. Provide a different email address if you want to view the agreement and agree to it.") + .addToModel(model, config); + return ERROR_PAGE; + } + else + { + String htmlSnippet = "

NOT AGREED

"; + + DoneExample.createDefault(this.title) + .withJsonObject(url) + .withMessage(getTextForCodeExample().ResultsPageText + htmlSnippet) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + } +} diff --git a/src/main/java/com/docusign/controller/click/examples/ClickwrapHelper.java b/src/main/java/com/docusign/controller/click/examples/ClickwrapHelper.java new file mode 100644 index 00000000..fc45e142 --- /dev/null +++ b/src/main/java/com/docusign/controller/click/examples/ClickwrapHelper.java @@ -0,0 +1,48 @@ +package com.docusign.controller.click.examples; + +import com.docusign.click.model.Document; +import com.docusign.core.utils.FileUtils; +import org.apache.commons.io.FilenameUtils; + +import java.io.IOException; +import java.util.Base64; + +public class ClickwrapHelper { + + public static final String STATUS_ACTIVE = "active"; + + /** + * Loads document from a file and creates a document object that represents + * loaded document. + * + * @param fileName name of the file to load document; the extension of the + * loading file determines an extension of the created document + * @param docName the name of the document; it may be differ from the file + * @param order order of the created document + * @return the {@link Document} object + * @throws IOException if document cannot be loaded due to some reason + */ + public static Document createDocumentFromFile(String fileName, String docName, Integer order) throws IOException { + byte[] buffer = FileUtils.readFile(fileName); + String extension = FilenameUtils.getExtension(fileName); + return createDocument(buffer, docName, extension, order); + } + + /** + * Creates a document object from the raw data. + * + * @param data the raw data + * @param documentName the name of the document; it may be differ from the file + * @param fileExtension the extension of the creating file + * @param order order of the created document + * @return the {@link Document} object + */ + static Document createDocument(byte[] data, String documentName, String fileExtension, Integer order) { + Document document = new Document(); + document.setDocumentBase64(Base64.getEncoder().encodeToString(data)); + document.setDocumentName(documentName); + document.setFileExtension(fileExtension); + document.setOrder(order); + return document; + } +} diff --git a/src/main/java/com/docusign/controller/click/services/ActivateClickwrapService.java b/src/main/java/com/docusign/controller/click/services/ActivateClickwrapService.java new file mode 100644 index 00000000..acaa9111 --- /dev/null +++ b/src/main/java/com/docusign/controller/click/services/ActivateClickwrapService.java @@ -0,0 +1,39 @@ +package com.docusign.controller.click.services; + +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapRequest; +import com.docusign.click.model.ClickwrapVersionSummaryResponse; +import com.docusign.click.model.ClickwrapVersionsResponse; +import com.docusign.controller.click.examples.ClickwrapHelper; + + +public final class ActivateClickwrapService { + public static ClickwrapVersionSummaryResponse activateClickwrap( + AccountsApi accountsApi, + String accountId, + String clickwrapId, + String clickwrapVersionNumber) throws ApiException { + //ds-snippet-start:Click2Step3 + ClickwrapRequest clickwrapRequest = new ClickwrapRequest().status(ClickwrapHelper.STATUS_ACTIVE); + //ds-snippet-end:Click2Step3 + + //ds-snippet-start:Click2Step4 + return accountsApi.updateClickwrapVersion( + accountId, + clickwrapId, + clickwrapVersionNumber, + clickwrapRequest); + //ds-snippet-end:Click2Step4 + } + + public static ClickwrapVersionsResponse getClickwrapsByStatus( + AccountsApi accountsApi, + String accountId, + String status + ) throws ApiException { + AccountsApi.GetClickwrapsOptions options = accountsApi.new GetClickwrapsOptions(); + options.setStatus(status); + return accountsApi.getClickwraps(accountId, options); + } +} diff --git a/src/main/java/com/docusign/controller/click/services/CreateClickwrapService.java b/src/main/java/com/docusign/controller/click/services/CreateClickwrapService.java new file mode 100644 index 00000000..b95222e8 --- /dev/null +++ b/src/main/java/com/docusign/controller/click/services/CreateClickwrapService.java @@ -0,0 +1,48 @@ +package com.docusign.controller.click.services; + +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapRequest; +import com.docusign.click.model.ClickwrapVersionSummaryResponse; +import com.docusign.click.model.DisplaySettings; +import com.docusign.click.model.Document; +import com.docusign.controller.click.examples.ClickwrapHelper; + +import java.io.IOException; + +public final class CreateClickwrapService { + //ds-snippet-start:Click1Step3 + public static ClickwrapRequest createClickwrapRequest( + String clickwrapName, + String fileName, + String documentName, + Integer documentOrder + ) throws IOException { + Document document = ClickwrapHelper.createDocumentFromFile(fileName, documentName, documentOrder); + DisplaySettings displaySettings = new DisplaySettings() + .displayName("Terms of Service") + .consentButtonText("I Agree") + .downloadable(true) + .format("modal") + .mustRead(true) + .requireAccept(true) + .documentDisplay("document"); + + return new ClickwrapRequest() + .addDocumentsItem(document) + .clickwrapName(clickwrapName) + .requireReacceptance(true) + .displaySettings(displaySettings); + } + //ds-snippet-end:Click1Step3 + + public static ClickwrapVersionSummaryResponse createClickwrap( + AccountsApi accountsApi, + String accountId, + ClickwrapRequest clickwrapRequest + ) throws IOException, ApiException { + return accountsApi.createClickwrap( + accountId, + clickwrapRequest); + } +} diff --git a/src/main/java/com/docusign/controller/click/services/CreateNewVersionClickwrapService.java b/src/main/java/com/docusign/controller/click/services/CreateNewVersionClickwrapService.java new file mode 100644 index 00000000..f7afde58 --- /dev/null +++ b/src/main/java/com/docusign/controller/click/services/CreateNewVersionClickwrapService.java @@ -0,0 +1,54 @@ +package com.docusign.controller.click.services; + +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapRequest; +import com.docusign.click.model.ClickwrapVersionSummaryResponse; +import com.docusign.click.model.DisplaySettings; +import com.docusign.click.model.Document; +import com.docusign.controller.click.examples.ClickwrapHelper; + +import java.io.IOException; + +public final class CreateNewVersionClickwrapService { + public static ClickwrapVersionSummaryResponse createNewVersionClickwrap( + AccountsApi accountsApi, + ClickwrapRequest clickwrapRequest, + String accountId, + String clickwrapId + ) throws ApiException { + // Step 4: Call the v1 Click API + //ds-snippet-start:Click3Step4 + return accountsApi.createClickwrapVersion( + accountId, + clickwrapId, + clickwrapRequest); + //ds-snippet-end:Click3Step4 + } + + //ds-snippet-start:Click3Step3 + public static ClickwrapRequest createClickwrapRequest( + String fileName, + String documentName, + Integer documentOrder, + String clickwrapName + ) throws IOException { + Document document = ClickwrapHelper.createDocumentFromFile(fileName, documentName, documentOrder); + DisplaySettings displaySettings = new DisplaySettings() + .displayName(clickwrapName) + .consentButtonText("I Agree") + .downloadable(true) + .format("modal") + .mustRead(true) + .requireAccept(true) + .documentDisplay("document"); + + return new ClickwrapRequest() + .addDocumentsItem(document) + .clickwrapName(clickwrapName) + .requireReacceptance(true) + .status(ClickwrapHelper.STATUS_ACTIVE) + .displaySettings(displaySettings); + } + //ds-snippet-end:Click3Step3 +} diff --git a/src/main/java/com/docusign/controller/click/services/EmbedClickwrapService.java b/src/main/java/com/docusign/controller/click/services/EmbedClickwrapService.java new file mode 100644 index 00000000..3014fa25 --- /dev/null +++ b/src/main/java/com/docusign/controller/click/services/EmbedClickwrapService.java @@ -0,0 +1,54 @@ +package com.docusign.controller.click.services; + +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.client.ApiResponse; +import com.docusign.click.model.ClickwrapVersionsResponse; +import com.docusign.click.model.UserAgreementRequest; +import com.docusign.click.model.UserAgreementResponse; + +import java.util.HashMap; +import java.util.Map; + +public final class EmbedClickwrapService { + public static String createAgreementUrl( + AccountsApi accountsApi, + String accountId, + String clickwrapId, + String fullName, + String email, + String company, + String title, + String date + ) throws ApiException { + + //ds-snippet-start:Click6Step3 + UserAgreementRequest userAgreementRequest = new UserAgreementRequest(); + userAgreementRequest.setClientUserId(email); + Map documentData = new HashMap(); + documentData.put("fullName", fullName); + documentData.put("email", email); + documentData.put("company", company); + documentData.put("title", title); + documentData.put("date", date); + userAgreementRequest.setDocumentData(documentData); + //ds-snippet-end:Click6Step3 + //ds-snippet-start:Click6Step4 + ApiResponse response = accountsApi.createHasAgreedWithHttpInfo(accountId, clickwrapId, userAgreementRequest); + + if (response.getStatusCode() == 201) { + return response.getData().getAgreementUrl(); + } + return "Already Agreed"; + //ds-snippet-end:Click6Step4 + } + + public static ClickwrapVersionsResponse getActiveClickwraps( + AccountsApi accountsApi, + String accountId + ) throws ApiException { + AccountsApi.GetClickwrapsOptions options = accountsApi.new GetClickwrapsOptions(); + options.setStatus("active"); + return accountsApi.getClickwraps(accountId, options); + } +} diff --git a/src/main/java/com/docusign/controller/click/services/GetClickwrapResponsesService.java b/src/main/java/com/docusign/controller/click/services/GetClickwrapResponsesService.java new file mode 100644 index 00000000..0c6efb6c --- /dev/null +++ b/src/main/java/com/docusign/controller/click/services/GetClickwrapResponsesService.java @@ -0,0 +1,16 @@ +package com.docusign.controller.click.services; + +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapAgreementsResponse; + +public final class GetClickwrapResponsesService { + public static ClickwrapAgreementsResponse getClickwrapResponses( + AccountsApi accountsApi, + String accountId, + String clickwrapId + ) throws ApiException { + // Step 3: Call the v1 Click API + return accountsApi.getClickwrapAgreements(accountId, clickwrapId); + } +} diff --git a/src/main/java/com/docusign/controller/click/services/GetListClickwrapsService.java b/src/main/java/com/docusign/controller/click/services/GetListClickwrapsService.java new file mode 100644 index 00000000..6b022939 --- /dev/null +++ b/src/main/java/com/docusign/controller/click/services/GetListClickwrapsService.java @@ -0,0 +1,17 @@ +package com.docusign.controller.click.services; + +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapVersionsResponse; + +public final class GetListClickwrapsService { + public static ClickwrapVersionsResponse getListClickwrap( + AccountsApi accountsApi, + String accountId + ) throws ApiException { + // Step 3: Call the v1 Click API + //ds-snippet-start:Click4Step3 + return accountsApi.getClickwraps(accountId); + //ds-snippet-end:Click4Step3 + } +} diff --git a/src/main/java/com/docusign/controller/connect/examples/AbstractConnectController.java b/src/main/java/com/docusign/controller/connect/examples/AbstractConnectController.java new file mode 100644 index 00000000..177dec65 --- /dev/null +++ b/src/main/java/com/docusign/controller/connect/examples/AbstractConnectController.java @@ -0,0 +1,22 @@ +package com.docusign.controller.connect.examples; + +import com.docusign.DSConfiguration; +import com.docusign.core.controller.AbstractController; +import org.springframework.stereotype.Controller; + +/** + * Abstract base class for all Connect controllers. + */ +@Controller +public abstract class AbstractConnectController extends AbstractController { + + private static final String EXAMPLE_PAGES_PATH = "pages/connect/examples/"; + + public AbstractConnectController(DSConfiguration config, String exampleName) { + super(config, exampleName); + } + + protected String getExamplePagesPath() { + return AbstractConnectController.EXAMPLE_PAGES_PATH; + } +} diff --git a/src/main/java/com/docusign/controller/connect/examples/EG001ControllerValidateUsingHMAC.java b/src/main/java/com/docusign/controller/connect/examples/EG001ControllerValidateUsingHMAC.java new file mode 100644 index 00000000..e97f0f84 --- /dev/null +++ b/src/main/java/com/docusign/controller/connect/examples/EG001ControllerValidateUsingHMAC.java @@ -0,0 +1,42 @@ +package com.docusign.controller.connect.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.connect.services.ValidateUsingHmacService; +import com.docusign.core.model.DoneExample; +import com.docusign.esign.client.ApiException; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.security.InvalidKeyException; +import java.security.NoSuchAlgorithmException; + +@Controller +@RequestMapping("/con001") +public class EG001ControllerValidateUsingHMAC extends AbstractConnectController { + + @Autowired + public EG001ControllerValidateUsingHMAC(DSConfiguration config) { + super(config, "con001"); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException, NoSuchAlgorithmException, InvalidKeyException { + String hashedOutput = new ValidateUsingHmacService().computeHash( + args.getHmacSecret(), + args.getJsonPayload().getBytes() + ); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", hashedOutput) + ) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/connect/services/ValidateUsingHmacService.java b/src/main/java/com/docusign/controller/connect/services/ValidateUsingHmacService.java new file mode 100644 index 00000000..9268f585 --- /dev/null +++ b/src/main/java/com/docusign/controller/connect/services/ValidateUsingHmacService.java @@ -0,0 +1,27 @@ +package com.docusign.controller.connect.services; + +import javax.crypto.Mac; +import javax.crypto.spec.SecretKeySpec; +import java.io.UnsupportedEncodingException; +import java.security.InvalidKeyException; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.Base64; + +public final class ValidateUsingHmacService { + public static String computeHash(String secret, byte[] payload) + throws InvalidKeyException, NoSuchAlgorithmException { + String digest = "HmacSHA256"; + Mac mac = Mac.getInstance(digest); + mac.init(new SecretKeySpec(secret.getBytes(), digest)); + String base64Hash = new String(Base64.getEncoder().encode(mac.doFinal(payload))); + return base64Hash; + } + + public static boolean isValid(String secret, byte[] payload, String verify) + throws InvalidKeyException, NoSuchAlgorithmException, UnsupportedEncodingException { + String computedHash = computeHash(secret, payload); + return MessageDigest.isEqual(computedHash.getBytes("UTF-8"), + verify.getBytes("UTF-8")); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/AbstractEsignatureController.java b/src/main/java/com/docusign/controller/eSignature/examples/AbstractEsignatureController.java new file mode 100644 index 00000000..7a1b4079 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/AbstractEsignatureController.java @@ -0,0 +1,150 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.core.controller.AbstractController; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.api.TemplatesApi; +import com.docusign.esign.api.UsersApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.client.auth.OAuth; +import org.springframework.http.HttpHeaders; +import org.springframework.stereotype.Controller; + + +/** + * Abstract base class for all eSignature controllers. + */ +@Controller +public abstract class AbstractEsignatureController extends AbstractController { + + protected static final String MODEL_ENVELOPE_OK = "envelopeOk"; + + protected static final String MODEL_TEMPLATE_OK = "templateOk"; + + private static final String EXAMPLE_PAGES_PATH = "pages/esignature/examples/"; + + protected final Session session; + + protected final User user; + + public AbstractEsignatureController(DSConfiguration config, String exampleName, Session session, User user) { + super(config, exampleName); + this.session = session; + this.user = user; + } + + protected String getExamplePagesPath() { + return AbstractEsignatureController.EXAMPLE_PAGES_PATH; + } + + /** + * Creates new instance of the eSignature API client. + * + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return an instance of the {@link ApiClient} + */ + protected ApiClient createApiClient(String basePath, String userAccessToken) { + //ds-snippet-start:eSignJavaStep2 + ApiClient apiClient = new ApiClient(basePath); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + userAccessToken); + //ds-snippet-end:eSignJavaStep2 + return apiClient; + } + + /** + * Gets the information about the currently logged user. + * + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return an instance of the {@link OAuth.UserInfo} + */ + protected OAuth.UserInfo getCurrentUserInfo(String basePath, String userAccessToken) throws ApiException { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return apiClient.getUserInfo(userAccessToken); + } + + /** + * Creates a new instance of the eSignature EnvelopesApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return an instance of the {@link EnvelopesApi} + */ + protected EnvelopesApi createEnvelopesApi(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new EnvelopesApi(apiClient); + } + + /** + * Creates a new instance of the eSignature UsersApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return an instance of the {@link UsersApi} + */ + protected UsersApi createUsersApi(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new UsersApi(apiClient); + } + + /** + * Creates a new instance of the eSignature TemplatesApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return an instance of the {@link TemplatesApi} + */ + protected TemplatesApi createTemplatesApi(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new TemplatesApi(apiClient); + } + + /** + * Creates a new instance of the eSignature AccountsApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return an instance of the {@link AccountsApi} + */ + protected AccountsApi createAccountsApi(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new AccountsApi(apiClient); + } + + /** + * Get the email address of the authenticated user + * + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return users email address + */ + protected String getAuthenticatedUserEmail(String basePath, String userAccessToken) throws ApiException { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + OAuth.UserInfo userInfo = apiClient.getUserInfo(userAccessToken); + + return userInfo.getEmail(); + } + + /** + * Get the name of the authenticated user + * + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return users email address + */ + protected String getAuthenticatedUserName(String basePath, String userAccessToken) throws ApiException { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + OAuth.UserInfo userInfo = apiClient.getUserInfo(userAccessToken); + + return userInfo.getName(); + } +} diff --git a/src/main/java/com/docusign/controller/examples/DsModelUtils.java b/src/main/java/com/docusign/controller/eSignature/examples/DsModelUtils.java similarity index 96% rename from src/main/java/com/docusign/controller/examples/DsModelUtils.java rename to src/main/java/com/docusign/controller/eSignature/examples/DsModelUtils.java index e7a0921a..fb241007 100644 --- a/src/main/java/com/docusign/controller/examples/DsModelUtils.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/DsModelUtils.java @@ -1,4 +1,4 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.esign.model.AccountRoleSettings; import com.docusign.esign.model.SettingsMetadata; @@ -10,14 +10,17 @@ public final class DsModelUtils { public static final String FALSE = "false"; + public static final String TRUE = "true"; - private DsModelUtils() {} + private DsModelUtils() { + } /** * Creates {@link AccountRoleSettings} with default values. Now eSignature * API has an error. It requires a member 'signingUiVersion' but this class * doesn't contain such member. + * * @return a new AccountRoleSettings object */ public static AccountRoleSettings createDefaultRoleSettings() { diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG002ControllerSigningViaEmail.java b/src/main/java/com/docusign/controller/eSignature/examples/EG002ControllerSigningViaEmail.java new file mode 100644 index 00000000..e8d32075 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG002ControllerSigningViaEmail.java @@ -0,0 +1,69 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.SigningViaEmailService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Send an envelope with a remote (email) signer and cc recipient.
+ * The envelope includes a pdf, Word, and HTML document. Anchor text is used to + * position the signing fields in the documents. + */ +@Controller +@RequestMapping("/eg002") +public class EG002ControllerSigningViaEmail extends AbstractEsignatureController { + + @Autowired + public EG002ControllerSigningViaEmail(DSConfiguration config, Session session, User user) { + super(config, "eg002", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + // Set status for the makeEnvelope method + if (!EnvelopeHelpers.ENVELOPE_STATUS_CREATED.equalsIgnoreCase(args.getStatus())) { + args.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + } + + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + + EnvelopeDefinition envelope = SigningViaEmailService.makeEnvelope( + args.getSignerEmail(), + args.getSignerName(), + args.getCcEmail(), + args.getCcName(), + args.getStatus(), + args + ); + EnvelopeSummary envelopeSummary = SigningViaEmailService.signingViaEmail( + envelopesApi, + session.getAccountId(), + envelope); + + // process results + session.setEnvelopeId(envelopeSummary.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", envelopeSummary.getEnvelopeId()) + ) + .withJsonObject(envelopeSummary) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG003ControllerListEnvelopes.java b/src/main/java/com/docusign/controller/eSignature/examples/EG003ControllerListEnvelopes.java new file mode 100644 index 00000000..6be5bd47 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG003ControllerListEnvelopes.java @@ -0,0 +1,49 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.ListEnvelopesServices; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopesInformation; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; + + +/** + * List envelopes in the user's account.
+ * List the envelopes created in the last 30 days. This example demonstrates + * how to query DocuSign about envelopes sent by the current user. + */ +@Controller +@RequestMapping("/eg003") +public class EG003ControllerListEnvelopes extends AbstractEsignatureController { + + @Autowired + public EG003ControllerListEnvelopes(DSConfiguration config, Session session, User user) { + super(config, "eg003", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { + //ds-snippet-start:eSign3Step2 + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + EnvelopesInformation envelopesInformation = ListEnvelopesServices.listEnvelopes( + envelopesApi, + session.getAccountId()); + //ds-snippet-end:eSign3Step2 + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(envelopesInformation) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG004ControllerEnvelopeInfo.java b/src/main/java/com/docusign/controller/eSignature/examples/EG004ControllerEnvelopeInfo.java similarity index 65% rename from src/main/java/com/docusign/controller/examples/EG004ControllerEnvelopeInfo.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG004ControllerEnvelopeInfo.java index 9d6e90b0..8277ff10 100644 --- a/src/main/java/com/docusign/controller/examples/EG004ControllerEnvelopeInfo.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG004ControllerEnvelopeInfo.java @@ -1,20 +1,22 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.EnvelopeInfoService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -import javax.servlet.http.HttpServletResponse; - +import com.docusign.esign.model.Envelope; import org.apache.commons.lang3.StringUtils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; +import javax.servlet.http.HttpServletResponse; + /** * Get an envelope's basic information and status.
@@ -27,21 +29,15 @@ */ @Controller @RequestMapping("/eg004") -public class EG004ControllerEnvelopeInfo extends AbstractController { - - private final Session session; - private final User user; - +public class EG004ControllerEnvelopeInfo extends AbstractEsignatureController { @Autowired public EG004ControllerEnvelopeInfo(DSConfiguration config, Session session, User user) { - super(config, "eg004", "Get envelope information"); - this.session = session; - this.user = user; + super(config, "eg004", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); model.addAttribute(MODEL_ENVELOPE_OK, StringUtils.isNotBlank(session.getEnvelopeId())); } @@ -51,10 +47,14 @@ protected void onInitModel(WorkArguments args, ModelMap model) throws ApiExcepti protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { // Step 1. get envelope info EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - DoneExample.createDefault(title) - .withJsonObject(envelopesApi.getEnvelope(session.getAccountId(), session.getEnvelopeId())) - .withMessage("Results from the Envelopes::get method:") - .addToModel(model); + Envelope envelope = EnvelopeInfoService.envelopeInfo( + envelopesApi, + session.getAccountId(), + session.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(envelope) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; } // ***DS.snippet.0.end diff --git a/src/main/java/com/docusign/controller/examples/EG005ControllerEnvelopeRecipients.java b/src/main/java/com/docusign/controller/eSignature/examples/EG005ControllerEnvelopeRecipients.java similarity index 54% rename from src/main/java/com/docusign/controller/examples/EG005ControllerEnvelopeRecipients.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG005ControllerEnvelopeRecipients.java index ba10749f..d77dc73d 100644 --- a/src/main/java/com/docusign/controller/examples/EG005ControllerEnvelopeRecipients.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG005ControllerEnvelopeRecipients.java @@ -1,20 +1,22 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.EnvelopeRecipientsService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -import javax.servlet.http.HttpServletResponse; - +import com.docusign.esign.model.Recipients; import org.apache.commons.lang3.StringUtils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; +import javax.servlet.http.HttpServletResponse; + /** * List an envelope's recipients and their status.
@@ -22,35 +24,33 @@ */ @Controller @RequestMapping("/eg005") -public class EG005ControllerEnvelopeRecipients extends AbstractController { - - private final Session session; - private final User user; - +public class EG005ControllerEnvelopeRecipients extends AbstractEsignatureController { @Autowired public EG005ControllerEnvelopeRecipients(DSConfiguration config, Session session, User user) { - super(config, "eg005", "List envelope recipients"); - this.session = session; - this.user = user; + super(config, "eg005", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); model.addAttribute(MODEL_ENVELOPE_OK, StringUtils.isNotBlank(session.getEnvelopeId())); } @Override - // ***DS.snippet.0.start protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { - // Step 1. get envelope recipients + // Get envelope recipients + //ds-snippet-start:eSign5Step2 EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - DoneExample.createDefault(title) - .withJsonObject(envelopesApi.listRecipients(session.getAccountId(), session.getEnvelopeId())) - .withMessage("Results from the EnvelopeRecipients::list method:") - .addToModel(model); + Recipients recipients = EnvelopeRecipientsService.envelopeRecipients( + envelopesApi, + session.getAccountId(), + session.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(recipients) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; + //ds-snippet-end:eSign5Step2 } - // ***DS.snippet.0.end } diff --git a/src/main/java/com/docusign/controller/examples/EG006ControllerEnvelopeDocs.java b/src/main/java/com/docusign/controller/eSignature/examples/EG006ControllerEnvelopeDocs.java similarity index 70% rename from src/main/java/com/docusign/controller/examples/EG006ControllerEnvelopeDocs.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG006ControllerEnvelopeDocs.java index 3ffd3367..0174cb36 100644 --- a/src/main/java/com/docusign/controller/examples/EG006ControllerEnvelopeDocs.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG006ControllerEnvelopeDocs.java @@ -1,26 +1,26 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.EnvelopeDocsService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.EnvelopeDocumentInfo; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; import com.docusign.esign.model.EnvelopeDocument; import com.docusign.esign.model.EnvelopeDocumentsResult; -import com.docusign.model.DoneExample; -import com.docusign.model.EnvelopeDocumentInfo; -import com.docusign.model.Session; -import com.docusign.model.User; - -import java.util.ArrayList; -import java.util.List; - -import javax.servlet.http.HttpServletResponse; - import org.apache.commons.lang3.StringUtils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; +import javax.servlet.http.HttpServletResponse; +import java.util.ArrayList; +import java.util.List; + /** * List an envelope's documents.
@@ -31,20 +31,15 @@ */ @Controller @RequestMapping("/eg006") -public class EG006ControllerEnvelopeDocs extends AbstractController { - - private final Session session; - private final User user; +public class EG006ControllerEnvelopeDocs extends AbstractEsignatureController { @Autowired public EG006ControllerEnvelopeDocs(DSConfiguration config, Session session, User user) { - super(config, "eg006", "List envelope documents"); - this.session = session; - this.user = user; + super(config, "eg006", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); model.addAttribute(MODEL_ENVELOPE_OK, StringUtils.isNotBlank(session.getEnvelopeId())); } @@ -55,7 +50,10 @@ protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); // Step 1. List the envelope's documents - EnvelopeDocumentsResult result = envelopesApi.listDocuments(session.getAccountId(), session.getEnvelopeId()); + EnvelopeDocumentsResult envelopeDocumentsResult = EnvelopeDocsService.envelopeDocs( + envelopesApi, + session.getAccountId(), + session.getEnvelopeId()); // Step 2. Process results // Save the envelopeId and its list of documents in the session so @@ -65,7 +63,7 @@ protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse envelopeDocItems.add(new EnvelopeDocumentInfo("Combined", "content", "combined")); envelopeDocItems.add(new EnvelopeDocumentInfo("Zip archive", "zip", "archive")); - for (EnvelopeDocument doc : result.getEnvelopeDocuments()) { + for (EnvelopeDocument doc : envelopeDocumentsResult.getEnvelopeDocuments()) { String documentName = doc.getName(); if (StringUtils.equals(doc.getDocumentId(), "certificate")) { documentName = "Certificate of completion"; @@ -73,10 +71,10 @@ protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse envelopeDocItems.add(new EnvelopeDocumentInfo(documentName, doc.getType(), doc.getDocumentId())); } - DoneExample.createDefault(title) - .withJsonObject(result) - .withMessage("Results from the EnvelopeDocuments::list method:") - .addToModel(model); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(envelopeDocumentsResult) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; } // ***DS.snippet.0.end diff --git a/src/main/java/com/docusign/controller/examples/EG007ControllerEnvelopeGetDoc.java b/src/main/java/com/docusign/controller/eSignature/examples/EG007ControllerEnvelopeGetDoc.java similarity index 61% rename from src/main/java/com/docusign/controller/examples/EG007ControllerEnvelopeGetDoc.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG007ControllerEnvelopeGetDoc.java index f04d7ebf..22cacba7 100644 --- a/src/main/java/com/docusign/controller/examples/EG007ControllerEnvelopeGetDoc.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG007ControllerEnvelopeGetDoc.java @@ -1,15 +1,15 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; -import com.docusign.common.DocumentType; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.EnvelopeGetDocService; +import com.docusign.core.common.DocumentType; +import com.docusign.core.model.EnvelopeDocumentInfo; +import com.docusign.core.model.OptionItem; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; -import com.docusign.model.EnvelopeDocumentInfo; -import com.docusign.model.OptionItem; -import com.docusign.model.Session; -import com.docusign.model.User; - -import org.apache.commons.io.FilenameUtils; import org.apache.commons.lang3.StringUtils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpHeaders; @@ -17,13 +17,12 @@ import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; +import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.net.URLConnection; import java.util.ArrayList; import java.util.List; -import javax.servlet.http.HttpServletResponse; - /** * Download a document from an envelope.
@@ -31,26 +30,32 @@ */ @Controller @RequestMapping("/eg007") -public class EG007ControllerEnvelopeGetDoc extends AbstractController { +public class EG007ControllerEnvelopeGetDoc extends AbstractEsignatureController { private static final String MODEL_DOCUMENTS_OK = "documentsOk"; + private static final String MODEL_DOCUMENT_OPTIONS = "documentOptions"; - private static final String HTTP_CONTENT_DISPOSITION_VALUE = "inline;filename="; - private static final String ZIP_EXTENSION = "zip"; - private final Session session; - private final User user; + private static final String HTTP_CONTENT_DISPOSITION_VALUE = "inline;filename="; + private static final String ZIP_EXTENSION = "zip"; @Autowired public EG007ControllerEnvelopeGetDoc(DSConfiguration config, Session session, User user) { - super(config, "eg007", "Download a document"); - this.session = session; - this.user = user; + super(config, "eg007", session, user); + } + + private EnvelopeDocumentInfo find(List documents, String documentId) { + for (EnvelopeDocumentInfo docInfo : documents) { + if (StringUtils.equalsIgnoreCase(docInfo.getDocumentId(), documentId)) { + return docInfo; + } + } + throw new ExampleException("Requested document is not found.", null); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); model.addAttribute(MODEL_ENVELOPE_OK, StringUtils.isNotBlank(session.getEnvelopeId())); List envelopeDocuments = session.getEnvelopeDocuments(); @@ -60,63 +65,72 @@ protected void onInitModel(WorkArguments args, ModelMap model) throws ApiExcepti return; } + boolean foundPdfp = false; ArrayList documentOptions = new ArrayList<>(); for (EnvelopeDocumentInfo docInfo : envelopeDocuments) { + if (docInfo.getName() == "PDF Portfolio") { + foundPdfp = true; + } OptionItem doc = new OptionItem(docInfo.getName(), docInfo.getDocumentId()); documentOptions.add(doc); } + if (!foundPdfp) { + OptionItem pdfp = new OptionItem("PDF Portfolio", "portfolio"); + documentOptions.add(pdfp); + } model.addAttribute(MODEL_DOCUMENT_OPTIONS, documentOptions); } @Override - // ***DS.snippet.0.start protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { + HttpServletResponse response) throws ApiException, IOException { + // Step 2 start EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + // Step 2 end - // Step 1. EnvelopeDocuments::get. + // EnvelopeDocuments::get. // Exceptions will be caught by the calling function String documentId = args.getDocSelect(); - byte[] results = envelopesApi.getDocument(session.getAccountId(), session.getEnvelopeId(), documentId); - - // Step 2. process results + // Step 3 start + byte[] envelopeDocument = EnvelopeGetDocService.envelopeGetDoc( + envelopesApi, + session.getAccountId(), + session.getEnvelopeId(), + documentId); + // Step 3 end + + // Process results List envelopeDocuments = session.getEnvelopeDocuments(); + boolean foundPdfp = false; + for (EnvelopeDocumentInfo envDoc : envelopeDocuments) { + if (envDoc.getName() == "PDF Portfolio") { + foundPdfp = true; + break; + } + } + + if (!foundPdfp) { + EnvelopeDocumentInfo pdfp = new EnvelopeDocumentInfo("PDF Portfolio", "content", "portfolio"); + envelopeDocuments.add(pdfp); + } EnvelopeDocumentInfo docItem = find(envelopeDocuments, documentId); String docName = docItem.getName(); String docType = docItem.getType(); String pdfExtention = DocumentType.PDF.getDefaultFileExtention(); if (StringUtils.equalsAny(docType, "content", "summary", pdfExtention)) { - docName = addExtension(docName, pdfExtention); + docName = EnvelopeGetDocService.addExtension(docName, pdfExtention); } if (ZIP_EXTENSION.equals(docType)) { - docName = addExtension(docName, ZIP_EXTENSION); + docName = EnvelopeGetDocService.addExtension(docName, ZIP_EXTENSION); } response.setContentType(URLConnection.guessContentTypeFromName(docName)); - response.setContentLength(results.length); + response.setContentLength(envelopeDocument.length); response.setHeader(HttpHeaders.CONTENT_DISPOSITION, HTTP_CONTENT_DISPOSITION_VALUE + docName); - response.getOutputStream().write(results); + response.getOutputStream().write(envelopeDocument); response.flushBuffer(); return null; } - - private static String addExtension(String fileName, String extension) { - if (FilenameUtils.isExtension(fileName, extension)) { - return fileName; - } - return String.join(".", fileName, extension); - } - - private static EnvelopeDocumentInfo find(List documents, String documentId) { - for (EnvelopeDocumentInfo docInfo : documents) { - if (StringUtils.equalsIgnoreCase(docInfo.getDocumentId(), documentId)) { - return docInfo; - } - } - - throw new ExampleException("Requested document is not found.", null); - } - // ***DS.snippet.0.end } diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG008ControllerCreateTemplate.java b/src/main/java/com/docusign/controller/eSignature/examples/EG008ControllerCreateTemplate.java new file mode 100644 index 00000000..c8602ccc --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG008ControllerCreateTemplate.java @@ -0,0 +1,76 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.CreateTemplateService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeTemplate; +import com.docusign.esign.model.EnvelopeTemplateResults; +import com.docusign.esign.model.TemplateSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Create a template.
+ * Create a template with two roles, signer and cc. The template + * includes three documents. + */ +@Controller +@RequestMapping("/eg008") +public class EG008ControllerCreateTemplate extends AbstractEsignatureController { + + private static final String TEMPLATE_NAME = "Example Signer and CC template"; + + @Autowired + public EG008ControllerCreateTemplate(DSConfiguration config, Session session, User user) { + super(config, "eg008", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + // Step 1. list existing templates + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + String accountId = session.getAccountId(); + EnvelopeTemplateResults envelopeTemplateResults = CreateTemplateService.searchTemplatesByName( + apiClient, + accountId, + TEMPLATE_NAME); + + // Step 2. Process results. If template do not exist, create one + + if (Integer.parseInt(envelopeTemplateResults.getResultSetSize()) > 0) { + EnvelopeTemplate template = envelopeTemplateResults.getEnvelopeTemplates().get(0); + session.setTemplateId(template.getTemplateId()); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage( + "The template already exists in your account." + getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", template.getName()).replaceFirst("\\{1}", template.getTemplateId())) + .addToModel(model, config); + } else { + session.setTemplateName(TEMPLATE_NAME); + + //ds-snippet-start:eSign8Step3 + TemplateSummary template = CreateTemplateService.createTemplate(apiClient, accountId, CreateTemplateService.makeTemplate("Example Signer and CC template")); + //ds-snippet-end:eSign8Step3 + session.setTemplateId(template.getTemplateId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage( + "The template has been created!" + getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", template.getName()).replaceFirst("\\{1}", template.getTemplateId())) + .addToModel(model, config); + } + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG009ControllerUseTemplate.java b/src/main/java/com/docusign/controller/eSignature/examples/EG009ControllerUseTemplate.java similarity index 50% rename from src/main/java/com/docusign/controller/examples/EG009ControllerUseTemplate.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG009ControllerUseTemplate.java index d8183f8c..2722c893 100644 --- a/src/main/java/com/docusign/controller/examples/EG009ControllerUseTemplate.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG009ControllerUseTemplate.java @@ -1,23 +1,21 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.UseTemplateService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.api.TemplatesApi; import com.docusign.esign.client.ApiClient; import com.docusign.esign.client.ApiException; import com.docusign.esign.model.EnvelopeDefinition; import com.docusign.esign.model.EnvelopeSummary; import com.docusign.esign.model.EnvelopeTemplateResults; -import com.docusign.esign.model.TemplateRole; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; -import java.util.Arrays; import javax.servlet.http.HttpServletResponse; @@ -33,27 +31,20 @@ */ @Controller @RequestMapping("/eg009") -public class EG009ControllerUseTemplate extends AbstractController { +public class EG009ControllerUseTemplate extends AbstractEsignatureController { private static final String MODEL_LIST_TEMPLATE = "listTemplates"; - private final Session session; - private final User user; - - @Autowired public EG009ControllerUseTemplate(DSConfiguration config, Session session, User user) { - super(config, "eg009", "Envelope sent"); - this.session = session; - this.user = user; + super(config, "eg009", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); - TemplatesApi templatesApi = new TemplatesApi(apiClient); - EnvelopeTemplateResults templates = templatesApi.listTemplates(session.getAccountId()); + EnvelopeTemplateResults templates = UseTemplateService.listTemplates(apiClient, session.getAccountId()); model.addAttribute(MODEL_LIST_TEMPLATE, templates.getEnvelopeTemplates()); } @@ -61,35 +52,26 @@ protected void onInitModel(WorkArguments args, ModelMap model) throws ApiExcepti // ***DS.snippet.0.start protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - EnvelopeDefinition envelope = makeEnvelope(args); - EnvelopeSummary result = envelopesApi.createEnvelope(session.getAccountId(), envelope); - - session.setEnvelopeId(result.getEnvelopeId()); - DoneExample.createDefault(title) - .withJsonObject(result) - .withMessage("The envelope has been created and sent!
Envelope ID " - + result.getEnvelopeId() + ".") - .addToModel(model); + EnvelopeDefinition envelope = UseTemplateService.makeEnvelope( + args.getSignerName(), + args.getSignerEmail(), + args.getCcEmail(), + args.getCcName(), + args.getTemplateId() + ); + EnvelopeSummary envelopeSummary = UseTemplateService.createEnvelopeTemplate( + envelopesApi, + session.getAccountId(), + envelope); + + session.setEnvelopeId(envelopeSummary.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(envelopeSummary) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", envelopeSummary.getEnvelopeId()) + ) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; } - - private static EnvelopeDefinition makeEnvelope(WorkArguments args) { - TemplateRole signer = new TemplateRole(); - signer.setEmail(args.getSignerEmail()); - signer.setName(args.getSignerName()); - signer.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME); - - TemplateRole cc = new TemplateRole(); - cc.setEmail(args.getCcEmail()); - cc.setName(args.getCcName()); - cc.setRoleName(EnvelopeHelpers.CC_ROLE_NAME); - - EnvelopeDefinition envelope = new EnvelopeDefinition(); - envelope.setTemplateId(args.getTemplateId()); - envelope.setTemplateRoles(Arrays.asList(signer, cc)); - envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - - return envelope; - } // ***DS.snippet.0.end } diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG010ControllerSendBinaryDocs.java b/src/main/java/com/docusign/controller/eSignature/examples/EG010ControllerSendBinaryDocs.java new file mode 100644 index 00000000..ccb962e0 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG010ControllerSendBinaryDocs.java @@ -0,0 +1,56 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.SendBinaryDocsService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.json.JSONObject; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Send an envelope using binary document transfer.
+ * The envelope includes a pdf, doc, and HTML document. Multipart data transfer + * is used to send the documents in binary format to DocuSign. + */ +@Controller +@RequestMapping("/eg010") +public class EG010ControllerSendBinaryDocs extends AbstractEsignatureController { + + @Autowired + public EG010ControllerSendBinaryDocs(DSConfiguration config, Session session, User user) { + super(config, "eg010", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws IOException { + String responseString = SendBinaryDocsService.sendBinaryDocs( + args, + args.getSignerName(), + args.getSignerEmail(), + args.getCcName(), + args.getCcEmail(), + session.getBasePath(), + session.getAccountId(), + user.getAccessToken() + ); + JSONObject obj = new JSONObject(responseString); + String envelopeId = obj.getString("envelopeId"); + session.setEnvelopeId(envelopeId); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", envelopeId) + ) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG011ControllerEmbeddedSending.java b/src/main/java/com/docusign/controller/eSignature/examples/EG011ControllerEmbeddedSending.java similarity index 60% rename from src/main/java/com/docusign/controller/examples/EG011ControllerEmbeddedSending.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG011ControllerEmbeddedSending.java index 465248a8..dea59497 100644 --- a/src/main/java/com/docusign/controller/examples/EG011ControllerEmbeddedSending.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG011ControllerEmbeddedSending.java @@ -1,66 +1,66 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.EmbeddedSendingService; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.EnvelopeDefinition; import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.ReturnUrlRequest; import com.docusign.esign.model.ViewUrl; -import com.docusign.model.Session; -import com.docusign.model.User; - import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.servlet.view.RedirectView; -import java.io.IOException; - import javax.servlet.http.HttpServletResponse; +import java.io.IOException; /** - * Embedded Sending
+ * Use embedded sending
* An envelope will be created in draft mode. A browser will then be redirected * to the DocuSign web tool where the envelope can be (optionally) updated and * then sent. The envelope includes a pdf, Word, and HTML document. */ @Controller @RequestMapping("/eg011") -public class EG011ControllerEmbeddedSending extends AbstractController { - - private final Session session; - private final User user; - +public class EG011ControllerEmbeddedSending extends AbstractEsignatureController { @Autowired public EG011ControllerEmbeddedSending(DSConfiguration config, Session session, User user) { - super(config, "eg011", "Signing request by email"); - this.session = session; - this.user = user; + super(config, "eg011", session, user); } @Override // ***DS.snippet.0.start protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - String accountId = session.getAccountId(); + HttpServletResponse response) throws ApiException, IOException { + String accountId = this.session.getAccountId(); EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); // Step 1. Make the envelope with "created" (draft) status - args.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_CREATED); - EnvelopeDefinition env = EG002ControllerSigningViaEmail.makeEnvelope(args); - EnvelopeSummary results = envelopesApi.createEnvelope(accountId, env); - String envelopeId = results.getEnvelopeId(); + EnvelopeSummary envelopeSummary = EmbeddedSendingService.createEnvelopeWithDraftStatus( + envelopesApi, + args.getSignerEmail(), + args.getSignerName(), + args.getCcEmail(), + args.getCcName(), + args.getStatus(), + args, + accountId); + String envelopeId = envelopeSummary.getEnvelopeId(); // Step 2. Create the sender view. // Set the url where you want the recipient to go once they are done // signing should typically be a callback route somewhere in your app. - ReturnUrlRequest viewRequest = new ReturnUrlRequest(); - viewRequest.setReturnUrl(config.getDsReturnUrl()); - ViewUrl viewUrl = envelopesApi.createSenderView(accountId, envelopeId, viewRequest); + ViewUrl viewUrl = EmbeddedSendingService.createSenderView( + envelopesApi, + accountId, + envelopeId, + config.getDsReturnUrl()); // Switch to Recipient and Documents view if requested by the user String url = viewUrl.getUrl(); diff --git a/src/main/java/com/docusign/controller/examples/EG012ControllerEmbeddedConsole.java b/src/main/java/com/docusign/controller/eSignature/examples/EG012ControllerEmbeddedConsole.java similarity index 57% rename from src/main/java/com/docusign/controller/examples/EG012ControllerEmbeddedConsole.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG012ControllerEmbeddedConsole.java index 53a99994..1000c2d6 100644 --- a/src/main/java/com/docusign/controller/examples/EG012ControllerEmbeddedConsole.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG012ControllerEmbeddedConsole.java @@ -1,15 +1,13 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.EmbeddedConsoleService; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.ConsoleViewRequest; import com.docusign.esign.model.ViewUrl; -import com.docusign.model.Session; -import com.docusign.model.User; - -import javax.servlet.http.HttpServletResponse; - import org.apache.commons.lang3.StringUtils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @@ -17,6 +15,8 @@ import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.servlet.view.RedirectView; +import javax.servlet.http.HttpServletResponse; + /** * Embedded the DocuSign Web UI.
@@ -27,46 +27,33 @@ */ @Controller @RequestMapping("/eg012") -public class EG012ControllerEmbeddedConsole extends AbstractController { - - private final Session session; - private final User user; - +public class EG012ControllerEmbeddedConsole extends AbstractEsignatureController { @Autowired public EG012ControllerEmbeddedConsole(DSConfiguration config, Session session, User user) { - super(config, "eg012", "Embedded DocuSign web tool"); - this.session = session; - this.user = user; + super(config, "eg012", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); model.addAttribute(MODEL_ENVELOPE_OK, StringUtils.isNotBlank(session.getEnvelopeId())); } @Override - // ***DS.snippet.0.start protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { args.setDsReturnUrl(config.getDsReturnUrl()); EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - // Step 1. Create the Console / Web UI view. - // Set the URL where you want the recipient to go once they are finished in - // the Web UI. There are cases where a user will never click "FINISH" within - // the Web UI, you cannot assume control will be passed back to your application. - ConsoleViewRequest viewRequest = new ConsoleViewRequest(); - viewRequest.setReturnUrl(config.getDsReturnUrl()); - String envelopeId = session.getEnvelopeId(); - if ("envelope".equalsIgnoreCase(args.getStartingView()) && envelopeId != null) { - viewRequest.setEnvelopeId(envelopeId); - } - // Step 2. Call the CreateSenderView API - ViewUrl viewUrl = envelopesApi.createConsoleView(session.getAccountId(), viewRequest); + ViewUrl viewUrl = EmbeddedConsoleService.createConsoleView( + envelopesApi, + config.getDsReturnUrl(), + session.getEnvelopeId(), + args.getStartingView(), + session.getAccountId()); + return new RedirectView(viewUrl.getUrl()); } - // ***DS.snippet.0.end } diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG013ControllerAddDocToTemplate.java b/src/main/java/com/docusign/controller/eSignature/examples/EG013ControllerAddDocToTemplate.java new file mode 100644 index 00000000..3f6baac3 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG013ControllerAddDocToTemplate.java @@ -0,0 +1,72 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.AddDocToTemplateService; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.ViewUrl; +import org.apache.commons.lang3.StringUtils; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.servlet.view.RedirectView; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Use embedded signing from a template with an added document.
+ * This example sends an envelope based on a template. In addition to the + * template's document(s), the example adds an additional document to the + * envelope by using the Composite Templates. + */ +@Controller +@RequestMapping("/eg013") +public class EG013ControllerAddDocToTemplate extends AbstractEsignatureController { + + private final String SIGNER_CLIENT_ID = "1000"; + + @Autowired + public EG013ControllerAddDocToTemplate(DSConfiguration config, Session session, User user) { + super(config, "eg013", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + model.addAttribute(MODEL_TEMPLATE_OK, StringUtils.isNotBlank(session.getTemplateId())); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + + // Set status for the makeEnvelope method + if (!EnvelopeHelpers.ENVELOPE_STATUS_CREATED.equalsIgnoreCase(args.getStatus())) { + args.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + } + + String accountId = session.getAccountId(); + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + + ViewUrl embeddedEnvelope = AddDocToTemplateService.addDocumentToTemplate( + envelopesApi, + args.getSignerEmail(), + args.getSignerName(), + SIGNER_CLIENT_ID, + args.getCcEmail(), + args.getCcName(), + session.getTemplateId(), + accountId, + config.getDsReturnUrl(), + config.getDsPingUrl(), + args + ); + return new RedirectView(embeddedEnvelope.getUrl()); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG014ControllerCollectPayment.java b/src/main/java/com/docusign/controller/eSignature/examples/EG014ControllerCollectPayment.java new file mode 100644 index 00000000..2e1067f7 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG014ControllerCollectPayment.java @@ -0,0 +1,87 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.CollectPaymentService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Send an envelope with an order form, including a payment field.
+ * This class programmatically constructs the order form. For many use cases, + * it would be better to create the order form as a template using the DocuSign + * web tool as a WYSIWYG form designer.
+ * Note: This example will only work if the sender's DocuSign account is + * set up with a DocuSign payment gateway. Next properties should are set: + *
    + *
  • Gateway_Account_Id
    • + *
  • Gateway_Name
    • + *
  • Gateway_Display_Name
    • + *
+ * Since the Payment Gateway ID is set in the configuration file, you will need + * to run your own instance of this project to set it. + */ +@Controller +@RequestMapping("/eg014") +public class EG014ControllerCollectPayment extends AbstractEsignatureController { + + private static final String MODEL_GATEWAY_OK = "gatewayOk"; + + @Autowired + public EG014ControllerCollectPayment(DSConfiguration config, Session session, User user) { + super(config, "eg014", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + model.addAttribute(MODEL_GATEWAY_OK, null != config.getGatewayAccountId()); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + + // Step 1. Make the envelope request body + EnvelopeDefinition envelope = CollectPaymentService.makeEnvelope( + args.getSignerEmail(), + args.getSignerName(), + args.getCcName(), + args.getCcEmail(), + config.getGatewayAccountId(), + config.getGatewayName(), + config.getGatewayDisplayName(), + args); + + // Step 2. call Envelopes::create API method + EnvelopeSummary envelopeSummary = CollectPaymentService.collectPayment(envelopesApi, envelope, session.getAccountId()); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", envelopeSummary.getEnvelopeId()) + ) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/examples/EG015ControllerGetTabValues.java b/src/main/java/com/docusign/controller/eSignature/examples/EG015ControllerGetTabValues.java similarity index 52% rename from src/main/java/com/docusign/controller/examples/EG015ControllerGetTabValues.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG015ControllerGetTabValues.java index aba862d8..5ffda1f1 100644 --- a/src/main/java/com/docusign/controller/examples/EG015ControllerGetTabValues.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG015ControllerGetTabValues.java @@ -1,11 +1,14 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.GetTabValuesService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; +import com.docusign.esign.model.EnvelopeFormData; import org.apache.commons.lang3.StringUtils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @@ -21,35 +24,34 @@ */ @Controller @RequestMapping("/eg015") -public class EG015ControllerGetTabValues extends AbstractController { - - private final Session session; - private final User user; - +public class EG015ControllerGetTabValues extends AbstractEsignatureController { @Autowired public EG015ControllerGetTabValues(DSConfiguration config, Session session, User user) { - super(config, "eg015", "Get Envelope Tabs"); - this.session = session; - this.user = user; + super(config, "eg015", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); model.addAttribute(MODEL_ENVELOPE_OK, StringUtils.isNotBlank(session.getEnvelopeId())); } @Override - // ***DS.snippet.0.start protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { - // Step 1. get envelope recipients + //ds-snippet-start:eSign15Step2 EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - DoneExample.createDefault(title) - .withJsonObject(envelopesApi.getFormData(session.getAccountId(), session.getEnvelopeId())) - .withMessage("Results from the Envelope::GetFormData method:") - .addToModel(model); + //ds-snippet-end:eSign15Step2 + //ds-snippet-start:eSign15Step3 + EnvelopeFormData envelopeFormData = GetTabValuesService.getTabValues( + envelopesApi, + session.getAccountId(), + session.getEnvelopeId()); + //ds-snippet-end:eSign15Step3 + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(envelopeFormData) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; } - // ***DS.snippet.0.end } diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG016ControllerSetTabValues.java b/src/main/java/com/docusign/controller/eSignature/examples/EG016ControllerSetTabValues.java new file mode 100644 index 00000000..aa08924b --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG016ControllerSetTabValues.java @@ -0,0 +1,70 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.SetTabValuesService; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.RecipientViewRequest; +import com.docusign.esign.model.ViewUrl; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.servlet.view.RedirectView; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +@Controller +@RequestMapping("/eg016") +public class EG016ControllerSetTabValues extends AbstractEsignatureController { + + @Autowired + public EG016ControllerSetTabValues(DSConfiguration config, Session session, User user) { + super(config, "eg016", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + String signerName = args.getSignerName(); + String signerEmail = args.getSignerEmail(); + String accountId = session.getAccountId(); + + EnvelopeDefinition envelope = SetTabValuesService.makeEnvelope(signerEmail, signerName); + + //ds-snippet-start:eSign16Step2 + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + //ds-snippet-end:eSign16Step2 + + // Call the eSignature REST API + //ds-snippet-start:eSign16Step4 + EnvelopeSummary envelopeSummary = SetTabValuesService.createEnvelope(envelopesApi, accountId, envelope); + //ds-snippet-end:eSign16Step4 + + String envelopeId = envelopeSummary.getEnvelopeId(); + session.setEnvelopeId(envelopeId); + + // Create the view request + //ds-snippet-start:eSign16Step5 + RecipientViewRequest viewRequest = SetTabValuesService.makeRecipientViewRequest( + signerEmail, + signerName, + config.getDsReturnUrl(), + config.getDsPingUrl()); + ViewUrl viewUrl = SetTabValuesService.createRecipientView(envelopesApi, accountId, envelopeId, viewRequest); + //ds-snippet-end:eSign16Step5 + + // State can be stored/recovered using the framework's session or a + // query parameter on the returnUrl (see the makeRecipientViewRequest method) + return new RedirectView(viewUrl.getUrl()); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG017ControllerSetTemplateTabValues.java b/src/main/java/com/docusign/controller/eSignature/examples/EG017ControllerSetTemplateTabValues.java new file mode 100644 index 00000000..3e04ac52 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG017ControllerSetTemplateTabValues.java @@ -0,0 +1,96 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.SetTemplateTabValuesService; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.api.TemplatesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.servlet.view.RedirectView; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +@Controller +@RequestMapping("/eg017") +public class EG017ControllerSetTemplateTabValues extends AbstractEsignatureController { + + private static final String MODEL_LIST_TEMPLATE = "listTemplates"; + + private static final String SIGNER_CLIENT_ID = "1000"; + + @Autowired + public EG017ControllerSetTemplateTabValues(DSConfiguration config, Session session, User user) { + super(config, "eg017", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + TemplatesApi templatesApi = new TemplatesApi(apiClient); + EnvelopeTemplateResults templates = templatesApi.listTemplates(session.getAccountId()); + model.addAttribute(MODEL_LIST_TEMPLATE, templates.getEnvelopeTemplates()); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + String signerName = args.getSignerName(); + String signerEmail = args.getSignerEmail(); + String accountId = session.getAccountId(); + String ccName = args.getCcName(); + String ccEmail = args.getCcEmail(); + String templateId = args.getTemplateId(); + + // Step 2. Construct your API headers + //ds-snippet-start:eSign17Step2 + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + //ds-snippet-end:eSign17Step2 + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + + // Step 3. is shown in the makeEnvelope method below + // Step 4. Construct your request body + EnvelopeDefinition envelope = SetTemplateTabValuesService.makeEnvelope( + signerEmail, + signerName, + ccEmail, + ccName, + templateId, + SIGNER_CLIENT_ID); + + // Step 5. Call the eSignature REST API + //ds-snippet-start:eSign17Step5 + EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); + String envelopeId = envelopeSummary.getEnvelopeId(); + session.setEnvelopeId(envelopeId); + //ds-snippet-end:eSign17Step5 + + // Step 6. Create the view request + RecipientViewRequest viewRequest = SetTemplateTabValuesService.makeRecipientViewRequest( + signerEmail, + signerName, + config.getDsReturnUrl(), + SIGNER_CLIENT_ID, + config.getDsPingUrl()); + + ViewUrl viewUrl = SetTemplateTabValuesService.setTemplateTabValues( + envelopesApi, + accountId, + envelopeId, + viewRequest + ); + + // State can be stored/recovered using the framework's session or a + // query parameter on the returnUrl (see the makeRecipientViewRequest method) + return new RedirectView(viewUrl.getUrl()); + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG018ControllerEnvelopeCustomFieldValues.java b/src/main/java/com/docusign/controller/eSignature/examples/EG018ControllerEnvelopeCustomFieldValues.java similarity index 54% rename from src/main/java/com/docusign/controller/examples/EG018ControllerEnvelopeCustomFieldValues.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG018ControllerEnvelopeCustomFieldValues.java index cd2eb53e..c6d2df0f 100644 --- a/src/main/java/com/docusign/controller/examples/EG018ControllerEnvelopeCustomFieldValues.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG018ControllerEnvelopeCustomFieldValues.java @@ -1,11 +1,14 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.EnvelopeCustomFieldValuesService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; +import com.docusign.esign.model.CustomFieldsEnvelope; import org.apache.commons.lang3.StringUtils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @@ -21,35 +24,36 @@ */ @Controller @RequestMapping("/eg018") -public class EG018ControllerEnvelopeCustomFieldValues extends AbstractController { - - private final Session session; - private final User user; - +public class EG018ControllerEnvelopeCustomFieldValues extends AbstractEsignatureController { @Autowired public EG018ControllerEnvelopeCustomFieldValues(DSConfiguration config, Session session, User user) { - super(config, "eg018", "Get Envelope Custom Field Data"); - this.session = session; - this.user = user; + super(config, "eg018", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); model.addAttribute(MODEL_ENVELOPE_OK, StringUtils.isNotBlank(session.getEnvelopeId())); } @Override - // ***DS.snippet.0.start protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { - // Step 1. get envelope recipients + //ds-snippet-start:eSign18Step2 EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - DoneExample.createDefault(title) - .withJsonObject(envelopesApi.listCustomFields(session.getAccountId(), session.getEnvelopeId())) - .withMessage("Results from the Envelope::GetFormData method:") - .addToModel(model); + //ds-snippet-end:eSign18Step2 + //ds-snippet-start:eSign18Step3 + CustomFieldsEnvelope customFieldsEnvelope = EnvelopeCustomFieldValuesService.envelopeCustomFieldValues( + envelopesApi, + session.getAccountId(), + session.getEnvelopeId() + ); + //ds-snippet-end:eSign18Step3 + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(customFieldsEnvelope) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; } - // ***DS.snippet.0.end } diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG019ControllerAccessCodeAuthentication.java b/src/main/java/com/docusign/controller/eSignature/examples/EG019ControllerAccessCodeAuthentication.java new file mode 100644 index 00000000..94c32566 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG019ControllerAccessCodeAuthentication.java @@ -0,0 +1,65 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.AccessCodeAuthenticationService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Send an envelope with a recipient using Access Code Authentication. Signer + * has to enter an access code for opening document to sign. + */ +@Controller +@RequestMapping("/eg019") +public class EG019ControllerAccessCodeAuthentication extends AbstractEsignatureController { + + @Autowired + public EG019ControllerAccessCodeAuthentication(DSConfiguration config, Session session, User user) { + super(config, "eg019", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + // Step 1: Construct your API headers + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + + // Step 2: Construct your envelope JSON body + EnvelopeDefinition envelope = AccessCodeAuthenticationService.createEnvelope( + args.getSignerName(), + args.getSignerEmail(), + args.getAccessCode() + ); + + // Step 3: Call the eSignature REST API + EnvelopeSummary envelopeSummary = AccessCodeAuthenticationService.accessCodeAuthentication( + envelopesApi, + session.getAccountId(), + envelope + ); + + session.setEnvelopeId(envelopeSummary.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(envelopeSummary) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", session.getEnvelopeId()) + ) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG020ControllerPhoneAuthentication.java b/src/main/java/com/docusign/controller/eSignature/examples/EG020ControllerPhoneAuthentication.java new file mode 100644 index 00000000..4eb6bcc0 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG020ControllerPhoneAuthentication.java @@ -0,0 +1,93 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.PhoneAuthenticationService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.AccountIdentityVerificationResponse; +import com.docusign.esign.model.AccountIdentityVerificationWorkflow; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.util.List; + +/** + * Example 020: Phone Authentication for recipient + */ +@Controller +@RequestMapping("/eg020") +public class EG020ControllerPhoneAuthentication extends AbstractEsignatureController { + + private static final Logger LOGGER = LoggerFactory.getLogger(EG023ControllerIdvAuthentication.class); + + @Autowired + public EG020ControllerPhoneAuthentication(DSConfiguration config, Session session, User user) { + super(config, "eg020", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) + throws ApiException, IOException { + String accountId = session.getAccountId(); + + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + + //ds-snippet-start:eSign20Step3 + AccountsApi workflowDetails = new AccountsApi(apiClient); + AccountIdentityVerificationResponse workflowRes = workflowDetails.getAccountIdentityVerification(session.getAccountId()); + List identityVerification = workflowRes.getIdentityVerification(); + String workflowId = ""; + for (int i = 0; i < identityVerification.size(); i++) { + if (identityVerification.get(i).getDefaultName().equals("Phone Authentication")) { + workflowId = identityVerification.get(i).getWorkflowId(); + } + } + //ds-snippet-end:eSign20Step3 + LOGGER.info("workflowId = " + workflowId); + if (workflowId.equals("")) { + throw new ApiException(0, getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessage); + } + //ds-snippet-start:eSign20Step5 + EnvelopeDefinition envelope = PhoneAuthenticationService.createEnvelope(args.getSignerName(), args.getSignerEmail(), args.getCountryCode(), + args.getPhoneNumber(), workflowId); + //ds-snippet-end:eSign20Step5 + //ds-snippet-start:eSign20Step4 + EnvelopeSummary results = PhoneAuthenticationService.phoneAuthentication(envelopesApi, accountId, envelope); + //ds-snippet-end:eSign20Step4 + + session.setEnvelopeId(results.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(results) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", results.getEnvelopeId()) + ) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG022ControllerKBAAuthentication.java b/src/main/java/com/docusign/controller/eSignature/examples/EG022ControllerKBAAuthentication.java new file mode 100644 index 00000000..d1829655 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG022ControllerKBAAuthentication.java @@ -0,0 +1,64 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.KBAAuthenticationService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Send an envelope with a recipient using Knowledge-Based Authentication. + */ +@Controller +@RequestMapping("/eg022") +public class EG022ControllerKBAAuthentication extends AbstractEsignatureController { + + @Autowired + public EG022ControllerKBAAuthentication(DSConfiguration config, Session session, User user) { + super(config, "eg022", session, user); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + // Step 1: Construct your API headers + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + + // Step 2: Construct your envelope JSON body + EnvelopeDefinition envelope = KBAAuthenticationService.createEnvelope( + args.getSignerName(), + args.getSignerEmail()); + + // Step 3: Call the eSignature REST API + EnvelopeSummary envelopeSummary = KBAAuthenticationService.kbaAuthentication( + envelopesApi, + session.getAccountId(), + envelope + ); + + session.setEnvelopeId(envelopeSummary.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(envelopeSummary) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", envelopeSummary.getEnvelopeId()) + ) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG023ControllerIdvAuthentication.java b/src/main/java/com/docusign/controller/eSignature/examples/EG023ControllerIdvAuthentication.java new file mode 100644 index 00000000..86c15c69 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG023ControllerIdvAuthentication.java @@ -0,0 +1,62 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.IdvAuthenticationService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * ID Verification authentication + */ +@Controller +@RequestMapping("/eg023") +public class EG023ControllerIdvAuthentication extends AbstractEsignatureController { + + private static final Logger LOGGER = LoggerFactory.getLogger(EG023ControllerIdvAuthentication.class); + + @Autowired + public EG023ControllerIdvAuthentication(DSConfiguration config, Session session, User user) { + super(config, "eg023", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException, IOException { + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + String workflowId = IdvAuthenticationService.retrieveWorkflowId(apiClient, session.getAccountId()); + LOGGER.info("workflowId = " + workflowId); + if (workflowId.equals("")) { + throw new ApiException(0, getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessage); + } + EnvelopeDefinition envelope = IdvAuthenticationService.createEnvelope(args.getSignerName(), args.getSignerEmail(), workflowId); + //ds-snippet-start:eSign23Step5 + EnvelopeSummary results = IdvAuthenticationService.idvAuthentication(envelopesApi, session.getAccountId(), envelope); + //ds-snippet-end:eSign23Step5 + + session.setEnvelopeId(results.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(results) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", results.getEnvelopeId()) + ) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG024ControllerPermissionCreate.java b/src/main/java/com/docusign/controller/eSignature/examples/EG024ControllerPermissionCreate.java similarity index 56% rename from src/main/java/com/docusign/controller/examples/EG024ControllerPermissionCreate.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG024ControllerPermissionCreate.java index 821b0eaf..d469b539 100644 --- a/src/main/java/com/docusign/controller/examples/EG024ControllerPermissionCreate.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG024ControllerPermissionCreate.java @@ -1,21 +1,21 @@ -package com.docusign.controller.examples; - -import java.io.IOException; - -import javax.servlet.http.HttpServletResponse; +package com.docusign.controller.eSignature.examples; +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.PermissionCreateService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.PermissionProfile; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; -import com.docusign.DSConfiguration; -import com.docusign.esign.api.AccountsApi; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.PermissionProfile; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; /** * Permission profiles are collections of account settings that determine the @@ -25,37 +25,34 @@ */ @Controller @RequestMapping("/eg024") -public class EG024ControllerPermissionCreate extends AbstractController{ - - private final Session session; - private final User user; +public class EG024ControllerPermissionCreate extends AbstractEsignatureController { @Autowired public EG024ControllerPermissionCreate(DSConfiguration config, Session session, User user) { - super(config, "eg024", "Creates a new permission profile"); - this.session = session; - this.user = user; + super(config, "eg024", session, user); } @Override protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException, IOException { + // Step 2. Construct your API headers AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); - // Step 3. Construct your request body - PermissionProfile profile = new PermissionProfile() - .permissionProfileName(args.getPermissionProfileName()) - .settings(DsModelUtils.createDefaultRoleSettings()); - // Step 4. Call the eSignature REST API - PermissionProfile newProfile = accountsApi.createPermissionProfile(session.getAccountId(), profile); + PermissionProfile newProfile = PermissionCreateService.createNewProfile( + accountsApi, + session.getAccountId(), + args.getPermissionProfileName() + ); - DoneExample.createDefault(title) + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) .withJsonObject(newProfile) - .withMessage("The permission profile is created!
Permission profile ID: " - + newProfile.getPermissionProfileId() + ".") - .addToModel(model); + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", newProfile.getPermissionProfileId()) + .replaceFirst("\\{1}", newProfile.getPermissionProfileName()) + ) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; } -} \ No newline at end of file +} diff --git a/src/main/java/com/docusign/controller/examples/EG025ControllerPermissionSetUserGroups.java b/src/main/java/com/docusign/controller/eSignature/examples/EG025ControllerPermissionSetUserGroups.java similarity index 65% rename from src/main/java/com/docusign/controller/examples/EG025ControllerPermissionSetUserGroups.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG025ControllerPermissionSetUserGroups.java index 90b30899..64968fa7 100644 --- a/src/main/java/com/docusign/controller/examples/EG025ControllerPermissionSetUserGroups.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG025ControllerPermissionSetUserGroups.java @@ -1,26 +1,24 @@ -package com.docusign.controller.examples; - -import java.util.List; - -import javax.servlet.http.HttpServletResponse; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.PermissionSetUserGroupsService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.AccountsApi; import com.docusign.esign.api.GroupsApi; import com.docusign.esign.client.ApiClient; import com.docusign.esign.client.ApiException; import com.docusign.esign.model.ErrorDetails; -import com.docusign.esign.model.Group; import com.docusign.esign.model.GroupInformation; import com.docusign.esign.model.PermissionProfileInformation; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; /** @@ -31,24 +29,19 @@ */ @Controller @RequestMapping("/eg025") -public class EG025ControllerPermissionSetUserGroups extends AbstractController { +public class EG025ControllerPermissionSetUserGroups extends AbstractEsignatureController { private static final String MODEL_LIST_PROFILES = "listProfiles"; - private static final String MODEL_LIST_GROUPS = "listGroups"; - - private final Session session; - private final User user; + private static final String MODEL_LIST_GROUPS = "listGroups"; @Autowired public EG025ControllerPermissionSetUserGroups(DSConfiguration config, Session session, User user) { - super(config, "eg025", "Setting a permission profile"); - this.session = session; - this.user = user; + super(config, "eg025", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); String accountId = session.getAccountId(); @@ -56,39 +49,44 @@ protected void onInitModel(WorkArguments args, ModelMap model) throws ApiExcepti PermissionProfileInformation permissionsInfo = accountsApi.listPermissions(accountId); model.addAttribute(MODEL_LIST_PROFILES, permissionsInfo.getPermissionProfiles()); + //ds-snippet-start:eSign25Step4 GroupsApi groupsApi = new GroupsApi(accountsApi.getApiClient()); GroupInformation groupInformation = groupsApi.listGroups(accountId); model.addAttribute(MODEL_LIST_GROUPS, groupInformation.getGroups()); + //ds-snippet-end:eSign25Step4 } @Override protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { - // Step 2: Construct your API headers + // Construct your API headers ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); - GroupsApi groupsApi = new GroupsApi(apiClient); - // Step 3: Perform request - Group newGroup = new Group() - .groupId(args.getGroupId()) - .permissionProfileId(args.getProfileId()); - GroupInformation groupInformation = new GroupInformation() - .groups(List.of(newGroup)); - GroupInformation newGroupInfo = groupsApi.updateGroups(session.getAccountId(), groupInformation); + //ds-snippet-start:eSign25Step3 + GroupInformation newGroupInfo = PermissionSetUserGroupsService.permissionSetUserGroups( + apiClient, + args.getGroupId(), + args.getProfileId(), + session.getAccountId() + ); + //ds-snippet-end:eSign25Step3 - // Step 4: Show result + // Show result ErrorDetails errorDetails = newGroupInfo.getGroups().get(0).getErrorDetails(); if (errorDetails != null) { new DoneExample() .withTitle(exampleName) .withName(title) - .withMessage(errorDetails.getMessage()) - .addToModel(model); + .withMessage( + getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessage + + "< br />Reason:" + + errorDetails.getMessage()) + .addToModel(model, config); return ERROR_PAGE; } - DoneExample.createDefault(title) + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) .withJsonObject(newGroupInfo) - .withMessage("The permission profile was successfully set to the user group!") - .addToModel(model); + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; } } diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG026ControllerPermissionChangeSingleSetting.java b/src/main/java/com/docusign/controller/eSignature/examples/EG026ControllerPermissionChangeSingleSetting.java new file mode 100644 index 00000000..aa3c55ac --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG026ControllerPermissionChangeSingleSetting.java @@ -0,0 +1,90 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.PermissionChangeSingleSettingService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.PermissionProfile; +import com.docusign.esign.model.PermissionProfileInformation; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.util.List; + +/** + * This code example demonstrates how to edit individual permission settings on + * a permission profile with the eSignature REST API. + */ +@Controller +@RequestMapping("/eg026") +public class EG026ControllerPermissionChangeSingleSetting extends AbstractEsignatureController { + + private static final String MODEL_CUR_PROFILE_NAME = "permissionProfileName"; + + private static final String MODEL_CUR_PROFILE_ID = "profileId"; + + private static final String MODEL_LIST_PROFILES = "listProfiles"; + + @Autowired + public EG026ControllerPermissionChangeSingleSetting(DSConfiguration config, Session session, User user) { + super(config, "eg026", session, user); + } + + @GetMapping("/profile") + public void getProfile(@RequestParam String profileId, ModelMap model) { + session.setPermissionProfileId(profileId); + model.addAttribute(MODEL_CUR_PROFILE_NAME, profileId); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); + + PermissionProfileInformation permissionsInfo = accountsApi.listPermissions(session.getAccountId()); + List profiles = permissionsInfo.getPermissionProfiles(); + model.addAttribute(MODEL_LIST_PROFILES, profiles); + + model.addAttribute(MODEL_CUR_PROFILE_NAME, profiles.get(0).getPermissionProfileName()); + model.addAttribute(MODEL_CUR_PROFILE_ID, profiles.get(0).getPermissionProfileId()); + PermissionChangeSingleSettingService.findProfile( + profiles, + session.getPermissionProfileId()).ifPresent((PermissionProfile curProfile) -> + { + model.addAttribute(MODEL_CUR_PROFILE_NAME, curProfile.getPermissionProfileName()); + model.addAttribute(MODEL_CUR_PROFILE_ID, curProfile.getPermissionProfileId()); + }); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) + throws ApiException, IOException { + // Step 2. Construct your API headers + AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); + String accountId = session.getAccountId(); + String curProfileId = args.getProfileId(); + + PermissionProfile newProfile = PermissionChangeSingleSettingService.permissionChangeSingleSetting( + accountsApi, + accountId, + curProfileId + ); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", newProfile.getPermissionProfileId()) + ) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE_COMPARE; + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG027ControllerPermissionDelete.java b/src/main/java/com/docusign/controller/eSignature/examples/EG027ControllerPermissionDelete.java similarity index 52% rename from src/main/java/com/docusign/controller/examples/EG027ControllerPermissionDelete.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG027ControllerPermissionDelete.java index 204beb0f..5c501fee 100644 --- a/src/main/java/com/docusign/controller/examples/EG027ControllerPermissionDelete.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG027ControllerPermissionDelete.java @@ -1,19 +1,20 @@ -package com.docusign.controller.examples; - -import javax.servlet.http.HttpServletResponse; +package com.docusign.controller.eSignature.examples; +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.PermissionDeleteService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.PermissionProfileInformation; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; -import com.docusign.DSConfiguration; -import com.docusign.esign.api.AccountsApi; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.PermissionProfileInformation; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; +import javax.servlet.http.HttpServletResponse; /** @@ -24,23 +25,17 @@ */ @Controller @RequestMapping("/eg027") -public class EG027ControllerPermissionDelete extends AbstractController { +public class EG027ControllerPermissionDelete extends AbstractEsignatureController { private static final String MODEL_LIST_PROFILES = "listProfiles"; - private final Session session; - private final User user; - - @Autowired public EG027ControllerPermissionDelete(DSConfiguration config, Session session, User user) { - super(config, "eg027", "Deleting a permission profile"); - this.session = session; - this.user = user; + super(config, "eg027", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); @@ -49,18 +44,31 @@ protected void onInitModel(WorkArguments args, ModelMap model) throws ApiExcepti } @Override - protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { - // Step 2: Construct your API headers + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) { + // Construct your API headers AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); - // Step 3: Call the eSignature Rest API to delete profile + // Call the eSignature Rest API to delete profile + //ds-snippet-start:eSign27Step3 String curProfileId = args.getProfileId(); - accountsApi.deletePermissionProfile(session.getAccountId(), curProfileId); + try { + PermissionDeleteService.permissionDelete(accountsApi, session.getAccountId(), curProfileId); + //ds-snippet-end:eSign27Step3 + + // Show 'done' (successful) page + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText.replaceFirst("\\{0}", curProfileId)) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } catch (ApiException e) { + new DoneExample() + .withTitle(exampleName) + .withName(title) + .withMessage(getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessage) + .addToModel(model, config); - // Step 4: Show 'done' (successful) page - DoneExample.createDefault(title) - .withMessage(String.join("", "The permission profile '", curProfileId, "' is deleted.")) - .addToModel(model); - return DONE_EXAMPLE_PAGE; + return ERROR_PAGE; + } } } diff --git a/src/main/java/com/docusign/controller/examples/EG028ControllerCreateBrand.java b/src/main/java/com/docusign/controller/eSignature/examples/EG028ControllerCreateBrand.java similarity index 57% rename from src/main/java/com/docusign/controller/examples/EG028ControllerCreateBrand.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG028ControllerCreateBrand.java index 9d87dd08..57d07d86 100644 --- a/src/main/java/com/docusign/controller/examples/EG028ControllerCreateBrand.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG028ControllerCreateBrand.java @@ -1,24 +1,22 @@ -package com.docusign.controller.examples; - -import java.io.IOException; -import java.util.List; - -import javax.servlet.http.HttpServletResponse; +package com.docusign.controller.eSignature.examples; +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.CreateBrandService; +import com.docusign.core.common.Languages; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.BrandsResponse; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; -import com.docusign.DSConfiguration; -import com.docusign.common.Languages; -import com.docusign.esign.api.AccountsApi; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.Brand; -import com.docusign.esign.model.BrandsResponse; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; /** @@ -27,23 +25,17 @@ */ @Controller @RequestMapping("/eg028") -public class EG028ControllerCreateBrand extends AbstractController{ +public class EG028ControllerCreateBrand extends AbstractEsignatureController { private static final String MODEL_LIST_LANGUAGE = "listLanguage"; - private final Session session; - private final User user; - - @Autowired public EG028ControllerCreateBrand(DSConfiguration config, Session session, User user) { - super(config, "eg028", "Creating a brand"); - this.session = session; - this.user = user; + super(config, "eg028", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); model.addAttribute(MODEL_LIST_LANGUAGE, Languages.getSupportedLanguages()); } @@ -55,20 +47,23 @@ protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); // Step 3: Construct your brand JSON body + //ds-snippet-start:eSign28Step3 String language = args.getLanguage(); - Brand brand = new Brand() - .brandName(args.getBrandName()) - .defaultBrandLanguage(language) - .brandLanguages(List.of(language)); - // Step 5: Call the eSignature REST API - BrandsResponse brandsResponse = accountsApi.createBrand(session.getAccountId(), brand); + BrandsResponse brandsResponse = CreateBrandService.createBrand( + accountsApi, + args.getBrandName(), + language, + session.getAccountId() + ); + //ds-snippet-end:eSign28Step3 - DoneExample.createDefault(title) + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) .withJsonObject(brandsResponse) - .withMessage("The brand has been created!
Brand ID " - + brandsResponse.getBrands().get(0).getBrandId() + ".") - .addToModel(model); + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", brandsResponse.getBrands().get(0).getBrandId()) + ) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; } } diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG029ControllerApplyBrandToEnvelope.java b/src/main/java/com/docusign/controller/eSignature/examples/EG029ControllerApplyBrandToEnvelope.java new file mode 100644 index 00000000..42173932 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG029ControllerApplyBrandToEnvelope.java @@ -0,0 +1,82 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.ApplyBrandToEnvelopeService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.BrandsResponse; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Applying a brand to an envelope
+ * The envelope includes a pdf document. Anchor text AutoPlace is used + * to position the signing fields in the documents. + */ +@Controller +@RequestMapping("/eg029") +public class EG029ControllerApplyBrandToEnvelope extends AbstractEsignatureController { + + private static final String MODEL_LIST_BRAND = "listBrands"; + + @Autowired + public EG029ControllerApplyBrandToEnvelope(DSConfiguration config, Session session, User user) { + super(config, "eg029", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); + BrandsResponse brands = ApplyBrandToEnvelopeService.getBrands(accountsApi, session.getAccountId()); + model.addAttribute(MODEL_LIST_BRAND, brands.getBrands()); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) + throws ApiException, IOException { + // Construct your API headers + //ds-snippet-start:eSign29Step2 + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + //ds-snippet-end:eSign29Step2 + + // Construct your envelope JSON body + //ds-snippet-start:eSign29Step3 + EnvelopeDefinition envelope = ApplyBrandToEnvelopeService.makeEnvelope( + args.getSignerEmail(), + args.getSignerName(), + args.getBrandId() + ); + //ds-snippet-end:eSign29Step3 + + // Call the eSignature REST API + //ds-snippet-start:eSign29Step4 + EnvelopeSummary envelopeSummary = ApplyBrandToEnvelopeService.applyBrandToEnvelope( + envelopesApi, + session.getAccountId(), + envelope + ); + //ds-snippet-end:eSign29Step4 + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withJsonObject(envelopeSummary) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", envelopeSummary.getEnvelopeId()) + ) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG030ControllerApplyBrandToTemplate.java b/src/main/java/com/docusign/controller/eSignature/examples/EG030ControllerApplyBrandToTemplate.java similarity index 71% rename from src/main/java/com/docusign/controller/examples/EG030ControllerApplyBrandToTemplate.java rename to src/main/java/com/docusign/controller/eSignature/examples/EG030ControllerApplyBrandToTemplate.java index c6d89bc4..f399b842 100644 --- a/src/main/java/com/docusign/controller/examples/EG030ControllerApplyBrandToTemplate.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG030ControllerApplyBrandToTemplate.java @@ -1,29 +1,28 @@ -package com.docusign.controller.examples; - -import java.io.IOException; -import java.util.Arrays; - -import javax.servlet.http.HttpServletResponse; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; +package com.docusign.controller.eSignature.examples; import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.ApplyBrandToTemplateService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; import com.docusign.esign.api.AccountsApi; import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.api.TemplatesApi; import com.docusign.esign.client.ApiClient; import com.docusign.esign.client.ApiException; import com.docusign.esign.model.BrandsResponse; import com.docusign.esign.model.EnvelopeDefinition; import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.EnvelopeTemplateResults; import com.docusign.esign.model.TemplateRole; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; +import org.apache.commons.lang3.StringUtils; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.util.Arrays; /** @@ -38,24 +37,19 @@ */ @Controller @RequestMapping("/eg030") -public class EG030ControllerApplyBrandToTemplate extends AbstractController { +public class EG030ControllerApplyBrandToTemplate extends AbstractEsignatureController { private static final String MODEL_LIST_BRAND = "listBrands"; - private static final String MODEL_LIST_TEMPLATE = "listTemplates"; - - private final Session session; - private final User user; + private static final String MODEL_LIST_TEMPLATE = "listTemplates"; @Autowired public EG030ControllerApplyBrandToTemplate(DSConfiguration config, Session session, User user) { - super(config, "eg030", "Apply brand to template"); - this.session = session; - this.user = user; + super(config, "eg030", session, user); } @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { super.onInitModel(args, model); String accountId = session.getAccountId(); ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); @@ -64,9 +58,7 @@ protected void onInitModel(WorkArguments args, ModelMap model) throws ApiExcepti BrandsResponse brands = accountsApi.listBrands(accountId); model.addAttribute(MODEL_LIST_BRAND, brands.getBrands()); - TemplatesApi templatesApi = new TemplatesApi(apiClient); - EnvelopeTemplateResults templates = templatesApi.listTemplates(accountId); - model.addAttribute(MODEL_LIST_TEMPLATE, templates.getEnvelopeTemplates()); + model.addAttribute(MODEL_TEMPLATE_OK, StringUtils.isNotBlank(session.getTemplateId())); } @Override @@ -76,20 +68,26 @@ protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); // Step 3: Construct your envelope JSON body - EnvelopeDefinition envelope = makeEnvelope(args); + EnvelopeDefinition envelope = makeEnvelope(args, session.getTemplateId()); - // Step 5: Call the eSignature REST API - EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(session.getAccountId(), envelope); + // Step 4: Call the eSignature REST API + EnvelopeSummary envelopeSummary = ApplyBrandToTemplateService.applyBrandToTemplate( + envelopesApi, + session.getAccountId(), + envelope + ); - DoneExample.createDefault(title) + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) .withJsonObject(envelopeSummary) - .withMessage("The envelope has been created and sent!
Envelope ID " - + envelopeSummary.getEnvelopeId() + ".") - .addToModel(model); + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", envelopeSummary.getEnvelopeId()) + ) + .addToModel(model, config); return DONE_EXAMPLE_PAGE; } - private static EnvelopeDefinition makeEnvelope(WorkArguments args) { + //ds-snippet-start:eSign30Step3 + private static EnvelopeDefinition makeEnvelope(WorkArguments args, String templateId) { TemplateRole signer = new TemplateRole() .email(args.getSignerEmail()) .name(args.getSignerName()) @@ -101,9 +99,10 @@ private static EnvelopeDefinition makeEnvelope(WorkArguments args) { .roleName(EnvelopeHelpers.CC_ROLE_NAME); return new EnvelopeDefinition() - .templateId(args.getTemplateId()) + .templateId(templateId) .templateRoles(Arrays.asList(signer, cc)) .brandId(args.getBrandId()) .status(EnvelopeHelpers.ENVELOPE_STATUS_SENT); } + //ds-snippet-end:eSign30Step3 } diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG031ControllerBulkSendEnvelopes.java b/src/main/java/com/docusign/controller/eSignature/examples/EG031ControllerBulkSendEnvelopes.java new file mode 100644 index 00000000..5161c9ab --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG031ControllerBulkSendEnvelopes.java @@ -0,0 +1,93 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.BulkSendEnvelopesService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.BulkEnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.BulkSendBatchStatus; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * This code example demonstrates how to send envelopes in bulk to multiple + * recipients with the eSignature API. To accomplish the task, you will first + * create a bulk send recipients list, and then create an envelope. From there, + * you will combine the envelope and bulk list to initiate bulk send + */ +@Controller +@RequestMapping("/eg031") +public class EG031ControllerBulkSendEnvelopes extends AbstractEsignatureController { + + private static final long BULK_REQUEST_DELAY = 15L; + + @Autowired + public EG031ControllerBulkSendEnvelopes(DSConfiguration config, Session session, User user) { + super(config, "eg031", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) + throws ApiException, IOException { + + // Construct your API headers + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + + // submit a bulk list + String accountId = session.getAccountId(); + BulkEnvelopesApi bulkEnvelopesApi = new BulkEnvelopesApi(apiClient); + String batchId = BulkSendEnvelopesService.bulkSendEnvelopes( + bulkEnvelopesApi, + apiClient, + args.getSignerName(), + args.getSignerEmail(), + args.getCcName(), + args.getCcEmail(), + args.getSignerName2(), + args.getSignerEmail2(), + args.getCcName2(), + args.getCcEmail2(), + session.getAccountId() + ); + + // Confirm successful bulk send + try { + + BulkSendBatchStatus status = BulkSendEnvelopesService.getBulkSendBatchStatus(bulkEnvelopesApi, accountId, batchId, BULK_REQUEST_DELAY); + + DoneExample.createDefault(getTextForCodeExample().ExampleName) + + .withJsonObject(status) + .withMessage(String.join( + "", + "Bulk request queued to ", status.getQueued(), " user lists.")) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } catch (InterruptedException exception) { + Thread.currentThread().interrupt(); + + new DoneExample() + .withTitle(exampleName) + .withName(title) + .withMessage( + getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessage + + "< br />Reason:" + + exception.getMessage() + ) + .addToModel(model, config); + + return ERROR_PAGE; + } + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG032ControllerPauseSignatureWorkflow.java b/src/main/java/com/docusign/controller/eSignature/examples/EG032ControllerPauseSignatureWorkflow.java new file mode 100644 index 00000000..62836b38 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG032ControllerPauseSignatureWorkflow.java @@ -0,0 +1,78 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.PauseSignatureWorkflowService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * This topic demonstrates how to create an envelope where the workflow + * is paused before the envelope is sent to a second recipient. + */ +@Controller +@RequestMapping("/eg032") +public class EG032ControllerPauseSignatureWorkflow extends AbstractEsignatureController { + + @Autowired + public EG032ControllerPauseSignatureWorkflow(DSConfiguration config, Session session, User user) { + super(config, "eg032", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) + throws ApiException, IOException { + + //ds-snippet-start:eSign32Step2 + EnvelopesApi envelopesApi = createEnvelopesApi(this.session.getBasePath(), this.user.getAccessToken()); + //ds-snippet-end:eSign32Step2 + + // Construct your envelope JSON body + EnvelopeDefinition envelope = PauseSignatureWorkflowService.createEnvelope( + args.getSignerName(), + args.getSignerEmail(), + args.getSignerName2(), + args.getSignerEmail2() + ); + + //ds-snippet-start:eSign32Step4 + EnvelopeSummary envelopeSummary = PauseSignatureWorkflowService.pauseSignatureWorkflow( + envelopesApi, + this.session.getAccountId(), + envelope + ); + //ds-snippet-end:eSign32Step4 + + this.session.setEnvelopeId(envelopeSummary.getEnvelopeId()); + DoneExample.createDefault(this.title) + .withJsonObject(envelopeSummary) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", this.session.getEnvelopeId()) + ) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG033ControllerUnpauseSignatureWorkflow.java b/src/main/java/com/docusign/controller/eSignature/examples/EG033ControllerUnpauseSignatureWorkflow.java new file mode 100644 index 00000000..fe918c86 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG033ControllerUnpauseSignatureWorkflow.java @@ -0,0 +1,64 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.UnpauseSignatureWorkflowService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeUpdateSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; + + +/** + * This topic demonstrates how to resume an envelope workflow that has been paused. + */ +@Controller +@RequestMapping("/eg033") +public class EG033ControllerUnpauseSignatureWorkflow extends AbstractEsignatureController { + + @Autowired + public EG033ControllerUnpauseSignatureWorkflow(DSConfiguration config, Session session, User user) { + super(config, "eg033", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + super.onInitModel(args, model); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { + + // Step 2: Construct your API headers + //ds-snippet-start:eSign33Step2 + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + //ds-snippet-end:eSign33Step2 + + EnvelopeUpdateSummary envelopeUpdateSummary = UnpauseSignatureWorkflowService.unpauseSignatureWorkflow( + envelopesApi, + this.session.getAccountId(), + this.session.getEnvelopeId() + ); + + DoneExample.createDefault(this.title) + .withJsonObject(envelopeUpdateSummary) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG034ControllerUseConditionalRecipients.java b/src/main/java/com/docusign/controller/eSignature/examples/EG034ControllerUseConditionalRecipients.java new file mode 100644 index 00000000..3f90fd93 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG034ControllerUseConditionalRecipients.java @@ -0,0 +1,87 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.UseConditionalRecipientsService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * This topic demonstrates how to create an envelope where the workflow + * is paused before the envelope is sent to a second recipient. + */ +@Controller +@RequestMapping("/eg034") +public class EG034ControllerUseConditionalRecipients extends AbstractEsignatureController { + + @Autowired + public EG034ControllerUseConditionalRecipients(DSConfiguration config, Session session, User user) { + super(config, "eg034", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) + throws ApiException, IOException { + // Step 2: Construct your API headers + EnvelopesApi envelopesApi = createEnvelopesApi(this.session.getBasePath(), this.user.getAccessToken()); + + // Step 3: Construct your envelope JSON body + //ds-snippet-start:eSign34Step3 + EnvelopeDefinition envelope = UseConditionalRecipientsService.createEnvelope( + args.getSignerNotCheckedName(), + args.getSignerNotCheckedEmail(), + args.getSignerCheckedName(), + args.getSignerCheckedEmail(), + args.getSignerName(), + args.getSignerEmail() + ); + //ds-snippet-end:eSign34Step3 + + // Step 4: Call the eSignature REST API + try { + EnvelopeSummary envelopeSummary = UseConditionalRecipientsService.useConditionalRecipients( + envelopesApi, + this.session.getAccountId(), + envelope + ); + + this.session.setEnvelopeId(envelopeSummary.getEnvelopeId()); + DoneExample.createDefault(this.title) + .withJsonObject(envelopeSummary) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", this.session.getEnvelopeId())) + .addToModel(model, config); + } catch (ApiException apiException) { + if (!apiException.getMessage().contains(getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessageCheck)) { + throw apiException; + } + DoneExample.createDefault(this.title) + .withMessage(getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessage) + .addToModel(model, config); + } + + return DONE_EXAMPLE_PAGE; + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG035ControllerScheduledSending.java b/src/main/java/com/docusign/controller/eSignature/examples/EG035ControllerScheduledSending.java new file mode 100644 index 00000000..17fdcc10 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG035ControllerScheduledSending.java @@ -0,0 +1,78 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.ScheduledSendlingService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Send an envelope with a remote (email) signer and cc recipient.
+ * The envelope includes a pdf, Word, and HTML document. Anchor text is used to + * position the signing fields in the documents. + */ +@Controller +@RequestMapping("/eg035") +public class EG035ControllerScheduledSending extends AbstractEsignatureController { + + private static final Logger log = LoggerFactory.getLogger(EG035ControllerScheduledSending.class); + + @Autowired + public EG035ControllerScheduledSending(DSConfiguration config, Session session, User user) { + super(config, "eg035", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + // Set status for the makeEnvelope method + if (!EnvelopeHelpers.ENVELOPE_STATUS_CREATED.equalsIgnoreCase(args.getStatus())) { + args.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + } + + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + + log.info("RESUMEDATE"); + log.info(args.getResumeDate() + "T00:00:00Z"); + + EnvelopeDefinition envelope = ScheduledSendlingService.makeEnvelope( + args.getSignerEmail(), + args.getSignerName(), + args.getResumeDate(), + args.getStatus()); + + // Step 3 start + //ds-snippet-start:eSign35Step3 + EnvelopeSummary results = envelopesApi.createEnvelope(session.getAccountId(), envelope); + //ds-snippet-end:eSign35Step3 + // Step 3 end + + log.info("ENVELOPE"); + log.info(results.getEnvelopeId()); + + // process results + session.setEnvelopeId(results.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", results.getEnvelopeId()) + ) + .withJsonObject(results) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG036ControllerDelayedRouting.java b/src/main/java/com/docusign/controller/eSignature/examples/EG036ControllerDelayedRouting.java new file mode 100644 index 00000000..99ebd2d3 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG036ControllerDelayedRouting.java @@ -0,0 +1,78 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.DelayedRoutingService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Send an envelope with a remote (email) signer and cc recipient.
+ * The envelope includes a pdf, Word, and HTML document. Anchor text is used to + * position the signing fields in the documents. + */ +@Controller +@RequestMapping("/eg036") +public class EG036ControllerDelayedRouting extends AbstractEsignatureController { + + @Autowired + public EG036ControllerDelayedRouting(DSConfiguration config, Session session, User user) { + super(config, "eg036", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + super.onInitModel(args, model); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + // Set status for the makeEnvelope method + if (!EnvelopeHelpers.ENVELOPE_STATUS_CREATED.equalsIgnoreCase(args.getStatus())) { + args.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + } + + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + + EnvelopeDefinition envelope = DelayedRoutingService.makeEnvelope( + args.getSignerName(), + args.getSignerEmail(), + args.getSignerName2(), + args.getSignerEmail2(), + args.getDelay(), + args.getStatus()); + + //ds-snippet-start:eSign36Step3 + EnvelopeSummary results = envelopesApi.createEnvelope(session.getAccountId(), envelope); + //ds-snippet-end:eSign36Step3 + + // process results + session.setEnvelopeId(results.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", results.getEnvelopeId()) + ) + .withJsonObject(results) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG037ControllerSMSDelivery.java b/src/main/java/com/docusign/controller/eSignature/examples/EG037ControllerSMSDelivery.java new file mode 100644 index 00000000..fdf4fbae --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG037ControllerSMSDelivery.java @@ -0,0 +1,81 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.SMSDeliveryService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * Send an envelope with a remote (email) signer and cc recipient.
+ * The envelope includes a pdf, Word, and HTML document. Anchor text is used to + * position the signing fields in the documents. + */ +@Controller +@RequestMapping("/eg037") +public class EG037ControllerSMSDelivery extends AbstractEsignatureController { + + @Autowired + public EG037ControllerSMSDelivery(DSConfiguration config, Session session, User user) { + super(config, "eg037", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + // Set status for the makeEnvelope method + if (!EnvelopeHelpers.ENVELOPE_STATUS_CREATED.equalsIgnoreCase(args.getStatus())) { + args.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + } + + EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + + EnvelopeDefinition envelope = SMSDeliveryService.makeEnvelope( + args.getCountryCode(), + args.getPhoneNumber(), + args.getSignerName(), + args.getDeliveryMethod(), + args.getCcCountryCode(), + args.getCcPhoneNumber(), + args.getCcName(), + args.getStatus() + ); + EnvelopeSummary envelopeSummary = SMSDeliveryService.smsDelivery( + envelopesApi, + session.getAccountId(), + envelope + ); + + // process results + session.setEnvelopeId(envelopeSummary.getEnvelopeId()); + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", envelopeSummary.getEnvelopeId()) + ) + .withJsonObject(envelopeSummary) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG038ControllerResponsiveSigning.java b/src/main/java/com/docusign/controller/eSignature/examples/EG038ControllerResponsiveSigning.java new file mode 100644 index 00000000..31062659 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG038ControllerResponsiveSigning.java @@ -0,0 +1,93 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.ResponsiveSigningService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.RecipientViewRequest; +import com.docusign.esign.model.ViewUrl; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.servlet.view.RedirectView; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +@Controller +@RequestMapping("/eg038") +public class EG038ControllerResponsiveSigning extends AbstractEsignatureController { + + private static final Logger log = LoggerFactory.getLogger(EG038ControllerResponsiveSigning.class); + + private static final String SIGNER_CLIENT_ID = "1000"; + + private static final String FEATURE_WAS_DISABLED = "Please enable this feature in the developer account and try again."; + + @Autowired + public EG038ControllerResponsiveSigning(DSConfiguration config, Session session, User user) { + super(config, "eg038", session, user); + } + + @Override + //ds-snippet-start:eSign38Step3 + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + String signerName = args.getSignerName(); + String signerEmail = args.getSignerEmail(); + String ccName = args.getCcName(); + String ccEmail = args.getCcEmail(); + String accountId = session.getAccountId(); + ViewUrl viewUrl = null; + + EnvelopeDefinition envelope = ResponsiveSigningService.makeEnvelope( + signerEmail, + signerName, + SIGNER_CLIENT_ID, + ccEmail, + ccName, + args); + + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + + try { + EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); + + String envelopeId = envelopeSummary.getEnvelopeId(); + + RecipientViewRequest viewRequest = ResponsiveSigningService.makeRecipientViewRequest( + signerEmail, + signerName, + config, + SIGNER_CLIENT_ID); + + viewUrl = ResponsiveSigningService.responsiveSigning( + envelopesApi, + accountId, + envelopeId, + viewRequest); + + } catch (ApiException apiException) { + log.error(apiException.getMessage()); + DoneExample.createDefault(this.title) + .withMessage("Feature Not Enabled") + .withFixingInstructions(FEATURE_WAS_DISABLED) + .addToModel(model, config); + return ERROR_PAGE; + } + + return new RedirectView(viewUrl.getUrl()); + } + //ds-snippet-end:eSign38Step3 +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG039ControllerInPersonSigning.java b/src/main/java/com/docusign/controller/eSignature/examples/EG039ControllerInPersonSigning.java new file mode 100644 index 00000000..8a8699f8 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG039ControllerInPersonSigning.java @@ -0,0 +1,82 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.InPersonSigningService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.RecipientViewRequest; +import com.docusign.esign.model.ViewUrl; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.servlet.view.RedirectView; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +@Controller +@RequestMapping("/eg039") +public class EG039ControllerInPersonSigning extends AbstractEsignatureController { + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "Lorem Ipsum"; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + + @Autowired + public EG039ControllerInPersonSigning(DSConfiguration config, Session session, User user) { + super(config, "eg039", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + super.onInitModel(args, model); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + String basePath = session.getBasePath(); + String accessToken = user.getAccessToken(); + + String hostName = getAuthenticatedUserName(basePath, accessToken); + String hostEmail = getAuthenticatedUserEmail(basePath, accessToken); + String signerName = args.getSignerName(); + String accountId = session.getAccountId(); + + EnvelopeDefinition envelope = InPersonSigningService.makeEnvelope(hostEmail, hostName, signerName, + ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X, DOCUMENT_FILE_NAME, DOCUMENT_NAME); + + //ds-snippet-start:eSign39Step3 + ApiClient apiClient = createApiClient(basePath, accessToken); + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + + EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); + //ds-snippet-end:eSign39Step3 + //ds-snippet-start:eSign39Step5 + RecipientViewRequest viewRequest = InPersonSigningService.makeRecipientViewRequest(hostEmail, hostName, config); + //ds-snippet-end:eSign39Step5 + + ViewUrl viewUrl = InPersonSigningService.inPersonSigning( + envelopesApi, + accountId, + envelopeSummary.getEnvelopeId(), + viewRequest); + + return new RedirectView(viewUrl.getUrl()); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG040ControllerSetDocumentVisibility.java b/src/main/java/com/docusign/controller/eSignature/examples/EG040ControllerSetDocumentVisibility.java new file mode 100644 index 00000000..2f7b5945 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG040ControllerSetDocumentVisibility.java @@ -0,0 +1,88 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.SetDocumentVisibilityService; +import com.docusign.core.common.Utils; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +@Controller +@RequestMapping("/eg040") +public class EG040ControllerSetDocumentVisibility extends AbstractEsignatureController { + private static final String DOCUMENT_FILE_NAME_PDF = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_FILE_NAME_DOCX = "World_Wide_Corp_Battle_Plan_Trafalgar.docx"; + + private static final String DOCUMENT_FILE_NAME_HTML = "doc_1.html"; + + private static final String CASE_FOR_INSTRUCTIONS = "ACCOUNT_LACKS_PERMISSIONS"; + + private static final String FIXING_INSTRUCTIONS_FOR_PERMISSIONS = "See " + + "" + + "How to set document visibility for envelope recipients in the DocuSign Developer Center " + + "for instructions on how to enable document visibility in your developer account."; + + @Autowired + public EG040ControllerSetDocumentVisibility(DSConfiguration config, Session session, User user) { + super(config, "eg040", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + if (Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId())) { + session.setStatusCFR("enabled"); + throw new Exception(config.getCodeExamplesText().getSupportingTexts().getCFRError()); + } + super.onInitModel(args, model); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws ApiException, IOException { + model.addAttribute("fixingInstructions", FIXING_INSTRUCTIONS_FOR_PERMISSIONS); + model.addAttribute("caseForInstructions", CASE_FOR_INSTRUCTIONS); + + String basePath = session.getBasePath(); + String accessToken = user.getAccessToken(); + + String signerName = args.getSignerName(); + String signerEmail = args.getSignerEmail(); + String signer2Name = args.getSignerName2(); + String signer2Email = args.getSignerEmail2(); + String ccName = args.getCcName(); + String ccEmail = args.getCcEmail(); + String accountId = session.getAccountId(); + + EnvelopeDefinition envelope = SetDocumentVisibilityService.makeEnvelope(signerEmail, signerName, signer2Email, + signer2Name, ccEmail, ccName, DOCUMENT_FILE_NAME_PDF, DOCUMENT_FILE_NAME_DOCX, DOCUMENT_FILE_NAME_HTML); + + //ds-snippet-start:eSign40Step2 + ApiClient apiClient = createApiClient(basePath, accessToken); + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + //ds-snippet-end:eSign40Step2 + + //ds-snippet-start:eSign40Step4 + EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); + //ds-snippet-end:eSign40Step4 + + DoneExample.createDefault(title) + .withMessage("The envelope has been created and sent!
Envelope ID " + + envelopeSummary.getEnvelopeId() + ".") + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG041ControllerCfrEmbeddedSigning.java b/src/main/java/com/docusign/controller/eSignature/examples/EG041ControllerCfrEmbeddedSigning.java new file mode 100644 index 00000000..5ecd2958 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG041ControllerCfrEmbeddedSigning.java @@ -0,0 +1,133 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.CfrEmbeddedSigningService; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.AccountIdentityVerificationResponse; +import com.docusign.esign.model.AccountIdentityVerificationWorkflow; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.RecipientViewRequest; +import com.docusign.esign.model.ViewUrl; + +import java.util.List; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.servlet.view.RedirectView; + +import javax.servlet.http.HttpServletResponse; +import java.util.List; + + +/** + * Use embedded signing.
+ * This example sends an envelope, and then uses embedded signing + * for the first signer. Embedded signing provides a smoother user experience + * for the signer: the DocuSign signing is initiated from your site. + */ +@Controller +@RequestMapping("/eg041") +public class EG041ControllerCfrEmbeddedSigning extends AbstractEsignatureController { + + private static final Logger LOGGER = LoggerFactory.getLogger(EG023ControllerIdvAuthentication.class); + + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "Lorem Ipsum"; + + private static final int ANCHOR_OFFSET_Y = -30; + + private static final int ANCHOR_OFFSET_X = 10; + + @Autowired + public EG041ControllerCfrEmbeddedSigning(DSConfiguration config, Session session, User user) { + super(config, "eg041", session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws Exception { + String signerName = args.getSignerName(); + String signerEmail = args.getSignerEmail(); + String signerClientId = args.getSignerEmail(); + String countryCode = args.getCountryCode(); + String phoneNumber = args.getPhoneNumber(); + String accountId = session.getAccountId(); + + //ds-snippet-start:eSign41Step2 + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + + AccountsApi workflowDetails = new AccountsApi(apiClient); + AccountIdentityVerificationResponse workflowRes = workflowDetails.getAccountIdentityVerification(session.getAccountId()); + List identityVerification = workflowRes.getIdentityVerification(); + String workflowId = ""; + for (int i = 0; i < identityVerification.size(); i++) { + if (identityVerification.get(i).getDefaultName().equals("SMS for access & signatures")) { + workflowId = identityVerification.get(i).getWorkflowId(); + } + } + //ds-snippet-end:eSign41Step2 + LOGGER.info("workflowId = " + workflowId); + if (workflowId.isEmpty()) { + throw new ApiException(0, getTextForCodeExample().CustomErrorTexts.get(0).ErrorMessage); + } + + // Create the envelope definition + //ds-snippet-start:eSign41Step4 + EnvelopeDefinition envelope = CfrEmbeddedSigningService.makeEnvelope( + signerName, + signerEmail, + countryCode, + phoneNumber, + workflowId, + signerClientId, + ANCHOR_OFFSET_Y, + ANCHOR_OFFSET_X, + DOCUMENT_FILE_NAME, + DOCUMENT_NAME); + + // Call DocuSign to create the envelope + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); + + String envelopeId = envelopeSummary.getEnvelopeId(); + //ds-snippet-end:eSign41Step4 + + session.setEnvelopeId(envelopeId); + + // create the recipient view, the embedded signing + //ds-snippet-start:eSign41Step5 + RecipientViewRequest viewRequest = CfrEmbeddedSigningService.makeRecipientViewRequest( + signerEmail, + signerName, + config, + signerClientId); + + //ds-snippet-end:eSign41Step5 + + //ds-snippet-start:eSign41Step6 + ViewUrl viewUrl = CfrEmbeddedSigningService.embeddedSigning( + envelopesApi, + accountId, + envelopeId, + viewRequest + ); + //ds-snippet-end:eSign41Step6 + + // Step 4. Redirect the user to the embedded signing + // Don't use an iFrame! + // State can be stored/recovered using the framework's session or a + // query parameter on the returnUrl (see the makeRecipientViewRequest method) + return new RedirectView(viewUrl.getUrl()); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG042ControllerDocumentGeneration.java b/src/main/java/com/docusign/controller/eSignature/examples/EG042ControllerDocumentGeneration.java new file mode 100644 index 00000000..36d2cf7f --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG042ControllerDocumentGeneration.java @@ -0,0 +1,60 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.DocumentGenerationService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.api.TemplatesApi; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; + +import static com.docusign.controller.eSignature.examples.EG042ControllerDocumentGeneration.EG_042; + +@Controller +@RequestMapping(EG_042) +public class EG042ControllerDocumentGeneration extends AbstractEsignatureController { + public static final String EG_042 = "/eg042"; + + private static final String DOCUMENT_FILE_NAME = "Offer_Letter_Demo.docx"; + + @Autowired + public EG042ControllerDocumentGeneration(DSConfiguration config, Session session, User user) { + super(config, EG_042, session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws Exception { + String basePath = session.getBasePath(); + String accessToken = user.getAccessToken(); + + EnvelopesApi envelopesApi = createEnvelopesApi(basePath, accessToken); + TemplatesApi templatesApi = createTemplatesApi(basePath, accessToken); + + String envelopeId = (new DocumentGenerationService()).generateDocument( + session.getAccountId(), + args.getCandidateEmail(), + args.getCandidateName(), + args.getManagerName(), + args.getJobTitle(), + args.getSalary(), + args.getStartDate(), + DOCUMENT_FILE_NAME, + envelopesApi, + templatesApi); + + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", envelopeId) + ) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG043ControllerSharedAccess.java b/src/main/java/com/docusign/controller/eSignature/examples/EG043ControllerSharedAccess.java new file mode 100644 index 00000000..9c39ced9 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG043ControllerSharedAccess.java @@ -0,0 +1,162 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.SharedAccessService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.api.UsersApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.client.auth.OAuth; +import com.docusign.esign.model.EnvelopesInformation; +import com.docusign.esign.model.NewUsersSummary; +import com.docusign.esign.model.UserInformation; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.MediaType; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; + +import javax.servlet.http.HttpServletResponse; + +import static com.docusign.controller.eSignature.examples.EG043ControllerSharedAccess.EG_043; + +@Controller +@RequestMapping(EG_043) +public class EG043ControllerSharedAccess extends AbstractEsignatureController { + public static final String EG_043 = "/eg043"; + + public static final String ACTIVATE_USER = "/activateUser"; + + public static final String LOGOUT = "/logout"; + + public static final String LIST_ENVELOPES = "/listEnvelopes"; + + public static final String ACT_ON_BEHALF = "X-DocuSign-Act-On-Behalf"; + + public static final String HOME_PAGE = "/"; + + public static final int AGENT_AUTHENTICATION_SUCCESSFULL = 0; + + public static final int AGENT_WAS_NOT_ACTIVATED = 3; + + public static final int NO_ENVELOPES_IN_USER_ACCOUNT = 2; + + public static final int ENVELOPES_MOVED_TO_ACCOUNT = 1; + + @Autowired + public EG043ControllerSharedAccess(DSConfiguration config, Session session, User user) { + super(config, EG_043, session, user); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws Exception { + String basePath = session.getBasePath(); + String accessToken = user.getAccessToken(); + + UsersApi usersApi = createUsersApi(basePath, accessToken); + + UserInformation userInformation = (new SharedAccessService()).getUserInfo( + usersApi, + session.getAccountId(), + args.getAgentEmail() + ); + + if (userInformation == null) { + NewUsersSummary usersSummary = (new SharedAccessService()).createAgent( + usersApi, + session.getAccountId(), + args.getAgentEmail(), + args.getAgentName(), + args.getActivationCode()); + + this.session.setCreatedUserId(usersSummary.getNewUsers().get(0).getUserId()); + + DoneExample.createDefault("Agent user created") + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(usersSummary) + .withRedirect(EG_043 + ACTIVATE_USER) + .addToModel(model, config); + } else { + this.session.setCreatedUserId(userInformation.getUserId()); + + DoneExample.createDefault("Agent user created") + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(userInformation) + .withRedirect(EG_043 + ACTIVATE_USER) + .addToModel(model, config); + } + + return DONE_EXAMPLE_PAGE; + } + + @RequestMapping(value = ACTIVATE_USER, method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE) + public String activateUser(ModelMap model) { + String basePath = session.getBasePath(); + String accessToken = user.getAccessToken(); + + AccountsApi accountsApi = createAccountsApi(basePath, accessToken); + + try { + OAuth.UserInfo user = getCurrentUserInfo(basePath, accessToken); + String userId = user.getSub(); + + (new SharedAccessService()).activateAgent( + accountsApi, + session.getAccountId(), + userId, + session.getCreatedUserId()); + + this.config.setPrincipalUserId(userId); + this.config.setShareAccessExampleScenario(true); + this.config.setAdditionalRedirect(true); + + DoneExample.createDefault("Authenticate as the agent") + .withMessage(getTextForCodeExampleByApiType().getAdditionalPage().get(AGENT_AUTHENTICATION_SUCCESSFULL).ResultsPageText) + .withRedirect(LOGOUT) + .addToModel(model, config); + } catch (ApiException exception) { + DoneExample.createDefault("Authenticate as the agent") + .withMessage(getTextForCodeExampleByApiType().getAdditionalPage().get(AGENT_WAS_NOT_ACTIVATED).ResultsPageText) + .withRedirect(EG_043 + ACTIVATE_USER) + .addToModel(model, config); + } + + return DONE_EXAMPLE_PAGE; + } + + @RequestMapping(value = LIST_ENVELOPES, method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE) + public String listEnvelopes(ModelMap model) throws ApiException { + String basePath = session.getBasePath(); + String accessToken = user.getAccessToken(); + + ApiClient apiClient = createApiClient(basePath, accessToken); + apiClient.addDefaultHeader(ACT_ON_BEHALF, this.config.getPrincipalUserId()); + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + + EnvelopesInformation envelopesInformation = (new SharedAccessService()).getEnvelopeInfo( + envelopesApi, + session.getAccountId()); + + if (envelopesInformation.getEnvelopes() == null || envelopesInformation.getEnvelopes().isEmpty()) { + DoneExample.createDefault("No envelopes in the principal user's account") + .withMessage(getTextForCodeExampleByApiType().getAdditionalPage().get(NO_ENVELOPES_IN_USER_ACCOUNT).ResultsPageText) + .withRedirect(HOME_PAGE) + .addToModel(model, config); + } else { + DoneExample.createDefault("Principal's envelopes visible in the agent's Shared Access UI") + .withMessage(getTextForCodeExampleByApiType().getAdditionalPage().get(ENVELOPES_MOVED_TO_ACCOUNT).ResultsPageText) + .withJson(envelopesInformation.toString()) + .withRedirect(HOME_PAGE) + .addToModel(model, config); + } + + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG044ControllerFocusedView.java b/src/main/java/com/docusign/controller/eSignature/examples/EG044ControllerFocusedView.java new file mode 100644 index 00000000..763c0a04 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/examples/EG044ControllerFocusedView.java @@ -0,0 +1,73 @@ +package com.docusign.controller.eSignature.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.services.FocusedViewService; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.esign.client.ApiClient; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; + + +/** + * Used to generate an envelope and allow user to sign it directly from the app without having to open an email. + */ +@Controller +@RequestMapping("/eg044") +public class EG044ControllerFocusedView extends AbstractEsignatureController { + public static final String EMBED = "pages/esignature/examples/embed"; + + public static final String INTEGRATION_KEY = "integrationKey"; + + public static final String URL = "url"; + + public static final String ENVELOPE_ID = "envelopeId"; + + public static final String DOCUMENTATION = "documentation"; + + @Autowired + public EG044ControllerFocusedView(DSConfiguration config, Session session, User user){ + super(config, "eg044", session, user); + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws Exception { + String signerName = args.getSignerName(); + String signerEmail = args.getSignerEmail(); + String accountId = session.getAccountId(); + + // Call DocuSign to create the envelope + ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + + // Call the method from Examples API to send envelope and generate url for focused view signing + String[] envelopeIdAndRedirectUrl = new FocusedViewService().sendEnvelopeWithFocusedView( + signerEmail, + signerName, + apiClient, + accountId, + config.getDsReturnUrl()); + + if(envelopeIdAndRedirectUrl.length == 2){ + model.addAttribute(ENVELOPE_ID, envelopeIdAndRedirectUrl[0]); + model.addAttribute(URL, envelopeIdAndRedirectUrl[1]); + } + + model.addAttribute(DOCUMENTATION, config.getDocumentationPath() + exampleName); + model.addAttribute(LAUNCHER_TEXTS, config.getCodeExamplesText().SupportingTexts); + model.addAttribute(INTEGRATION_KEY, config.getUserId()); + + return EMBED; + } +} diff --git a/src/main/java/com/docusign/controller/examples/EnvelopeHelpers.java b/src/main/java/com/docusign/controller/eSignature/examples/EnvelopeHelpers.java similarity index 59% rename from src/main/java/com/docusign/controller/examples/EnvelopeHelpers.java rename to src/main/java/com/docusign/controller/eSignature/examples/EnvelopeHelpers.java index 4961b596..bb8184b6 100644 --- a/src/main/java/com/docusign/controller/examples/EnvelopeHelpers.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/EnvelopeHelpers.java @@ -1,28 +1,17 @@ -package com.docusign.controller.examples; - -import java.io.IOException; -import java.io.StringWriter; -import java.nio.charset.StandardCharsets; -import java.util.Arrays; -import java.util.Base64; -import java.util.HashMap; -import java.util.Locale; -import java.util.Map; +package com.docusign.controller.eSignature.examples; +import com.docusign.esign.model.*; +import freemarker.template.Configuration; +import freemarker.template.Template; +import freemarker.template.TemplateException; import org.apache.commons.io.FilenameUtils; import org.springframework.core.io.ClassPathResource; import org.springframework.util.StreamUtils; -import com.docusign.esign.model.CarbonCopy; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.Recipients; -import com.docusign.esign.model.SignHere; -import com.docusign.esign.model.Signer; -import com.docusign.esign.model.Tabs; - -import freemarker.template.Configuration; -import freemarker.template.Template; -import freemarker.template.TemplateException; +import java.io.IOException; +import java.io.StringWriter; +import java.nio.charset.StandardCharsets; +import java.util.*; /** @@ -31,22 +20,35 @@ public final class EnvelopeHelpers { public static final String ENVELOPE_STATUS_SENT = "sent"; + public static final String ENVELOPE_STATUS_CREATED = "created"; + public static final String SIGNER_STATUS_CREATED = "Created"; + public static final String DELIVERY_METHOD_EMAIL = "Email"; + public static final String SIGNER_ROLE_NAME = "signer"; + public static final String CC_ROLE_NAME = "cc"; + public static final String WORKFLOW_STEP_ACTION_PAUSE = "pause_before"; + + public static final String WORKFLOW_TRIGGER_ROUTING_ORDER = "routing_order"; + + public static final String WORKFLOW_STATUS_IN_PROGRESS = "in_progress"; + - private EnvelopeHelpers() {} + private EnvelopeHelpers() { + } /** * Loads a file content and copy it into a byte array. + * * @param path the absolute path within the class path * @return the new byte array that has been loaded from the file * @throws IOException in case of I/O errors */ - static byte[] readFile(String path) throws IOException { + public static byte[] readFile(String path) throws IOException { ClassPathResource resource = new ClassPathResource(path); return StreamUtils.copyToByteArray(resource.getInputStream()); } @@ -56,6 +58,7 @@ static byte[] readFile(String path) throws IOException { * wherever and it is used when it is needed to generate the html document. * Html document is generated by the method. * {@link #createHtmlFromTemplate(Template, String, Object)} + * * @param path the path to template file * @return a {@link Template} object * @throws IOException in case of I/O errors @@ -72,19 +75,20 @@ static Template loadHtmlTemplate(String path) throws IOException { /** * Generates a html document from the template. Placeholder looks like * ${objectName.fieldName} - * @param template the template object + * + * @param template the template object * @param objectName name of object to find placeholder related to a value - * @param value object which fields are used as a values in the template + * @param value object which fields are used as a values in the template * @return array of bytes representing created html document * @throws IOException in case of template parsing error */ - static byte[] createHtmlFromTemplate(Template template, String objectName, Object value) throws IOException { + static String createHtmlFromTemplate(Template template, String objectName, Object value) throws IOException { Map input = new HashMap<>(); input.put(objectName, value); StringWriter stringWriter = new StringWriter(); try { template.process(input, stringWriter); - return stringWriter.toString().getBytes(StandardCharsets.UTF_8); + return stringWriter.toString(); } catch (TemplateException exception) { throw new ExampleException("Can't process html template " + template.getName(), exception); } @@ -95,13 +99,31 @@ static byte[] createHtmlFromTemplate(Template template, String objectName, Objec * ${objectName.fieldName}. It is a convenient method which loads template * from a file using {@link #loadHtmlTemplate(String)} and creates a html * page from the loaded template using {@link #createHtmlFromTemplate(Template, String, Object)} - * @param path the path to template file + * + * @param path the path to template file + * @param objectName name of object to find placeholder related to a value + * @param value object which fields are used as a values in the template + * @return array of bytes representing created html document + * @throws IOException in case of I/O errors or template parsing error + */ + public static byte[] createHtmlFromTemplateFileInByte(String path, String objectName, Object value) throws IOException { + Template template = loadHtmlTemplate(path); + return createHtmlFromTemplate(template, objectName, value).getBytes(StandardCharsets.UTF_8); + } + + /** + * Generates a html document from the template file. Placeholder looks like + * ${objectName.fieldName}. It is a convenient method which loads template + * from a file using {@link #loadHtmlTemplate(String)} and creates a html + * page from the loaded template using {@link #createHtmlFromTemplate(Template, String, Object)} + * + * @param path the path to template file * @param objectName name of object to find placeholder related to a value - * @param value object which fields are used as a values in the template + * @param value object which fields are used as a values in the template * @return array of bytes representing created html document * @throws IOException in case of I/O errors or template parsing error */ - static byte[] createHtmlFromTemplateFile(String path, String objectName, Object value) throws IOException { + public static String createHtmlFromTemplateFile(String path, String objectName, Object value) throws IOException { Template template = loadHtmlTemplate(path); return createHtmlFromTemplate(template, objectName, value); } @@ -109,32 +131,34 @@ static byte[] createHtmlFromTemplateFile(String path, String objectName, Object /** * Loads document from a file and creates a document object that represents * loaded document. + * * @param fileName name of the file to load document; the extension of the - * loading file determines an extension of the created document - * @param docName the name of the document; it may be differ from the file - * @param docId identifier of the created document + * loading file determines an extension of the created document + * @param docName the name of the document; it may be differ from the file + * @param docId identifier of the created document * @return the {@link Document} object * @throws IOException if document cannot be loaded due to some reason */ - static Document createDocumentFromFile(String fileName, String docName, String docId) throws IOException { + public static Document createDocumentFromFile(String fileName, String docName, String docId) throws IOException { byte[] buffer = readFile(fileName); - String extention = FilenameUtils.getExtension(fileName); - return createDocument(buffer, docName, extention, docId); + String extension = FilenameUtils.getExtension(fileName); + return createDocument(buffer, docName, extension, docId); } /** * Creates a document object from the raw data. - * @param data the raw data - * @param documentName the name of the document; it may be differ from the file - * @param fileExtention the extension of the creating file - * @param documentId identifier of the created document + * + * @param data the raw data + * @param documentName the name of the document; it may differ from the file + * @param fileExtension the extension of the creating file + * @param documentId identifier of the created document * @return the {@link Document} object */ - static Document createDocument(byte[] data, String documentName, String fileExtention, String documentId) { + public static Document createDocument(byte[] data, String documentName, String fileExtension, String documentId) { Document document = new Document(); document.setDocumentBase64(Base64.getEncoder().encodeToString(data)); document.setName(documentName); - document.setFileExtension(fileExtention); + document.setFileExtension(fileExtension); document.setDocumentId(documentId); return document; } @@ -142,13 +166,14 @@ static Document createDocument(byte[] data, String documentName, String fileExte /** * Create SignHere (see {@link SignHere}) field (also known as tabs) on the * documents using anchor (autoPlace) positioning. - * @param anchorString the anchor string; the DocuSign platform searches - * throughout your envelope's documents for matching anchor strings + * + * @param anchorString the anchor string; the DocuSign platform searches + * throughout your envelope's documents for matching anchor strings * @param yOffsetPixels the y offset of anchor in pixels * @param xOffsetPixels the x offset of anchor in pixels * @return the {@link SignHere} object */ - static SignHere createSignHere(String anchorString, int yOffsetPixels, int xOffsetPixels) { + public static SignHere createSignHere(String anchorString, int yOffsetPixels, int xOffsetPixels) { SignHere signHere = new SignHere(); signHere.setAnchorString(anchorString); signHere.setAnchorUnits("pixels"); @@ -160,23 +185,25 @@ static SignHere createSignHere(String anchorString, int yOffsetPixels, int xOffs /** * Create Tabs object containing a single SignHere (see {@link SignHere}) * field (also known as tabs) on the documents using anchor (autoPlace) positioning. - * @param anchorString the anchor string; the DocuSign platform searches - * throughout your envelope's documents for matching anchor strings + * + * @param anchorString the anchor string; the DocuSign platform searches + * throughout your envelope's documents for matching anchor strings * @param yOffsetPixels the y offset of anchor in pixels * @param xOffsetPixels the x offset of anchor in pixels * @return the {@link Tabs} object containing single SignHere object */ - static Tabs createSingleSignerTab(String anchorString, int yOffsetPixels, int xOffsetPixels) { + public static Tabs createSingleSignerTab(String anchorString, int yOffsetPixels, int xOffsetPixels) { SignHere signHere = createSignHere(anchorString, yOffsetPixels, xOffsetPixels); return createSignerTabs(signHere); } /** * Creates {@link SignHere} fields (also known as tabs) on the document. + * * @param signs the array of SignHere (see {@link SignHere}) * @return the {@link Tabs} object containing passed SignHere objects */ - static Tabs createSignerTabs(SignHere... signs) { + public static Tabs createSignerTabs(SignHere... signs) { Tabs signerTabs = new Tabs(); signerTabs.setSignHereTabs(Arrays.asList(signs)); return signerTabs; @@ -184,14 +211,27 @@ static Tabs createSignerTabs(SignHere... signs) { /** * Creates a {@link Recipients} object and add signer and cc to it. + * * @param signer the signer object - * @param cc the cc object + * @param cc the cc object * @return the {@link Recipients} object */ - static Recipients createRecipients(Signer signer, CarbonCopy cc) { + public static Recipients createRecipients(Signer signer, CarbonCopy cc) { + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + recipients.setCarbonCopies(Collections.singletonList(cc)); + return recipients; + } + + public static Recipients createSingleRecipient(Signer signer) { + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + return recipients; + } + + public static Recipients createTwoSigners(Signer signer, Signer signer2) { Recipients recipients = new Recipients(); - recipients.setSigners(Arrays.asList(signer)); - recipients.setCarbonCopies(Arrays.asList(cc)); + recipients.setSigners(Arrays.asList(signer, signer2)); return recipients; } } diff --git a/src/main/java/com/docusign/controller/examples/ExampleException.java b/src/main/java/com/docusign/controller/eSignature/examples/ExampleException.java similarity index 78% rename from src/main/java/com/docusign/controller/examples/ExampleException.java rename to src/main/java/com/docusign/controller/eSignature/examples/ExampleException.java index 09d7f8b3..c524da20 100644 --- a/src/main/java/com/docusign/controller/examples/ExampleException.java +++ b/src/main/java/com/docusign/controller/eSignature/examples/ExampleException.java @@ -1,4 +1,4 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.examples; /** * Unchecked exception caused by examples. @@ -9,8 +9,9 @@ public class ExampleException extends RuntimeException { /** * Constructs a new exception with the specified detail message and cause. + * * @param message the detail message, which is kept as member - * @param cause the cause, which is saved as member + * @param cause the cause, which is saved as member */ public ExampleException(String message, Throwable cause) { super(message, cause); diff --git a/src/main/java/com/docusign/controller/eSignature/services/AccessCodeAuthenticationService.java b/src/main/java/com/docusign/controller/eSignature/services/AccessCodeAuthenticationService.java new file mode 100644 index 00000000..c3095f7b --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/AccessCodeAuthenticationService.java @@ -0,0 +1,51 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Collections; + +public final class AccessCodeAuthenticationService { + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "Lorem"; + + public static EnvelopeSummary accessCodeAuthentication( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + //ds-snippet-start:eSign19Step4 + return envelopesApi.createEnvelope(accountId, envelope); + //ds-snippet-end:eSign19Step4 + } + + //ds-snippet-start:eSign19Step3 + public static EnvelopeDefinition createEnvelope( + String signerName, + String signerEmail, + String accessCode + ) throws IOException { + Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); + + Signer signer = KBAAuthenticationService.setSignHereAndSignerForEnvelope(signerName, signerEmail); + signer.setAccessCode(accessCode); + + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("Please Sign"); + envelope.setDocuments(Collections.singletonList(doc)); + envelope.setEnvelopeIdStamping("true"); + envelope.setEmailBlurb("Sample text for email body"); + envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + envelope.setRecipients(recipients); + + return envelope; + } + //ds-snippet-end:eSign19Step3 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/AddDocToTemplateService.java b/src/main/java/com/docusign/controller/eSignature/services/AddDocToTemplateService.java new file mode 100644 index 00000000..3590f0a2 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/AddDocToTemplateService.java @@ -0,0 +1,167 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.core.common.DocumentType; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.Arrays; +import java.util.Collections; + +public final class AddDocToTemplateService { + private static final String HTML_DOCUMENT_FILE_NAME = "templates/candy-bonbon2.ftl"; + + private static final String HTML_DOCUMENT_NAME = "Appendix 1--Sales order"; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + + public static ViewUrl addDocumentToTemplate( + EnvelopesApi envelopesApi, + String signerEmail, + String signerName, + String signerClientId, + String ccEmail, + String ccName, + String templateId, + String accountId, + String dsReturnUrl, + String dsPingUrl, + WorkArguments args + ) throws ApiException, IOException { + EnvelopeDefinition envelope = AddDocToTemplateService.makeEnvelope( + signerEmail, + signerName, + signerClientId, + ccEmail, + ccName, + templateId, + args + ); + + //ds-snippet-start:eSign13Step3 + EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); + //ds-snippet-end:eSign13Step3 + + //ds-snippet-start:eSign13Step4 + RecipientViewRequest viewRequest = AddDocToTemplateService.makeRecipientViewRequest( + dsReturnUrl, + signerEmail, + signerName, + dsPingUrl + ); + return envelopesApi.createRecipientView(accountId, envelopeSummary.getEnvelopeId(), viewRequest); + } + + public static RecipientViewRequest makeRecipientViewRequest( + String dsReturnUrl, + String signerEmail, + String signerName, + String dsPingUrl + ) { + RecipientViewRequest viewRequest = new RecipientViewRequest(); + // Set the url where you want the recipient to go once they are done signing + // should typically be a callback route somewhere in your app. + viewRequest.setReturnUrl(dsReturnUrl); + return SetTabValuesService.setEmailAndSignerNameForRecipientViewRequest( + viewRequest, + signerEmail, + signerName, + dsPingUrl); + } + //ds-snippet-end:eSign13Step4 + + // The envelope request object uses Composite Template to include in the envelope: + // 1. A template stored on the DocuSign service + // 2. An additional document which is a custom HTML source document + //ds-snippet-start:eSign13Step2 + public static EnvelopeDefinition makeEnvelope( + String signerEmail, + String signerName, + String signerClientId, + String ccEmail, + String ccName, + String templateId, + WorkArguments args + ) throws IOException { + // Create a signer and cc recipients for the signer role of the server template + CarbonCopy cc1 = new CarbonCopy(); + cc1.setEmail(ccEmail); + cc1.setName(ccName); + cc1.setRoleName(EnvelopeHelpers.CC_ROLE_NAME); + cc1.setRecipientId("2"); + + // create a composite template for the Server Template + CompositeTemplate compTemplate1 = new CompositeTemplate(); + compTemplate1.setCompositeTemplateId("1"); + ServerTemplate serverTemplates = new ServerTemplate(); + serverTemplates.setSequence("1"); + serverTemplates.setTemplateId(templateId); + compTemplate1.setServerTemplates(Collections.singletonList(serverTemplates)); + + // Add the roles via an inlineTemplate + InlineTemplate inlineTemplate = new InlineTemplate(); + inlineTemplate.setSequence("2"); + inlineTemplate.setRecipients(EnvelopeHelpers.createRecipients( + createSigner( + signerEmail, + signerName, + signerClientId + ), + cc1)); + compTemplate1.setInlineTemplates(Collections.singletonList(inlineTemplate)); + + // The signer recipient for the added document with a tab definition: + Tabs signer1Tabs = EnvelopeHelpers.createSingleSignerTab( + "**signature_1**", + ANCHOR_OFFSET_Y, + ANCHOR_OFFSET_X); + Signer signer1AddedDoc = createSigner( + signerEmail, + signerName, + signerClientId + ); + signer1AddedDoc.setTabs(signer1Tabs); + + // create the HTML document + byte[] htmlDoc = EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args) + .getBytes(StandardCharsets.UTF_8); + + // create a composite template for the added document and add the recipients via an inlineTemplate + CompositeTemplate compTemplate2 = new CompositeTemplate(); + compTemplate2.setCompositeTemplateId("2"); + InlineTemplate inlineTemplate2 = new InlineTemplate(); + inlineTemplate2.setSequence("1"); + inlineTemplate2.setRecipients(EnvelopeHelpers.createRecipients(signer1AddedDoc, cc1)); + compTemplate2.setInlineTemplates(Collections.singletonList(inlineTemplate2)); + compTemplate2.setDocument(EnvelopeHelpers.createDocument(htmlDoc, HTML_DOCUMENT_NAME, + DocumentType.HTML.getDefaultFileExtention(), "1")); + + EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); + envelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + envelopeDefinition.setCompositeTemplates(Arrays.asList(compTemplate1, compTemplate2)); + + return envelopeDefinition; + } + //ds-snippet-end:eSign13Step2 + + // Adding clientUserId transforms the template recipient into an embedded recipient + public static Signer createSigner( + String signerEmail, + String signerName, + String signerClientId + ) { + Signer signer = new Signer(); + signer.setEmail(signerEmail); + signer.setName(signerName); + signer.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + signer.setRecipientId("1"); + signer.setClientUserId(signerClientId); + return signer; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/ApplyBrandToEnvelopeService.java b/src/main/java/com/docusign/controller/eSignature/services/ApplyBrandToEnvelopeService.java new file mode 100644 index 00000000..e17592c1 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/ApplyBrandToEnvelopeService.java @@ -0,0 +1,73 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Collections; +import java.util.List; + +public final class ApplyBrandToEnvelopeService { + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "EG025 Lorem Ipsum"; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + + //ds-snippet-start:eSign29Step4 + public static EnvelopeSummary applyBrandToEnvelope( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + return envelopesApi.createEnvelope(accountId, envelope); + } + //ds-snippet-end:eSign29Step4 + + public static BrandsResponse getBrands( + AccountsApi accountsApi, + String accountId + ) throws ApiException { + return accountsApi.listBrands(accountId); + } + + // Creates an envelope. The envelope has one recipient who should sign an + // attached document. Attached document is read from a local directory. + // Also the envelope contains a brand Id which is created on EG028 example. + //ds-snippet-start:eSign29Step3 + public static EnvelopeDefinition makeEnvelope( + String signerEmail, + String signerName, + String brandId + ) throws IOException { + // Reads a file from a local directory and create Document object. + Document document = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); + + // Create a signer recipient to sign the document and associate sign tab + Tabs tabs = EnvelopeHelpers.createSingleSignerTab("/sn1/", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X); + Signer signer = new Signer() + .email(signerEmail) + .name(signerName) + .recipientId("1") + .routingOrder("1") + .tabs(tabs); + + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + // Return envelope definition using created objects: the document, + // the recipients and obtained brand Id. + return new EnvelopeDefinition() + .emailSubject("EG029. Please Sign") + .documents(List.of(document)) + .recipients(recipients) + .brandId(brandId) + .status(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + } + //ds-snippet-end:eSign29Step3 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/ApplyBrandToTemplateService.java b/src/main/java/com/docusign/controller/eSignature/services/ApplyBrandToTemplateService.java new file mode 100644 index 00000000..dc755583 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/ApplyBrandToTemplateService.java @@ -0,0 +1,47 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.TemplateRole; + +import java.util.Arrays; + +public final class ApplyBrandToTemplateService { + public static EnvelopeSummary applyBrandToTemplate( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + //ds-snippet-start:eSign30Step4 + return envelopesApi.createEnvelope(accountId, envelope); + //ds-snippet-end:eSign30Step4 + } + + public static EnvelopeDefinition makeEnvelope( + String signerEmail, + String signerName, + String ccEmail, + String ccName, + String templateId, + String brandId + ) { + TemplateRole signer = new TemplateRole() + .email(signerEmail) + .name(signerName) + .roleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + + TemplateRole cc = new TemplateRole() + .email(ccEmail) + .name(ccName) + .roleName(EnvelopeHelpers.CC_ROLE_NAME); + + return new EnvelopeDefinition() + .templateId(templateId) + .templateRoles(Arrays.asList(signer, cc)) + .brandId(brandId) + .status(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/BulkSendEnvelopesService.java b/src/main/java/com/docusign/controller/eSignature/services/BulkSendEnvelopesService.java new file mode 100644 index 00000000..a311a234 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/BulkSendEnvelopesService.java @@ -0,0 +1,186 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.DsModelUtils; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.BulkEnvelopesApi; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.TimeUnit; + +public final class BulkSendEnvelopesService { + private static final String BULK_SIGNER_EMAIL_PLACEHOLDER = "MultiBulkRecipients-%s@docusign.com"; + + private static final String BULK_SIGNER_NAME_PLACEHOLDER = "Multi Bulk Recipients::%s"; + + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "Lorem Ipsum"; + + private static final int ANCHOR_OFFSET_Y = -5; + + private static final int ANCHOR_OFFSET_X = 15; + + //ds-snippet-start:eSign31Step7 + public static BulkSendBatchStatus getBulkSendBatchStatus( + BulkEnvelopesApi bulkEnvelopesApi, + String accountId, + String batchId, + long bulkRequestDelay + ) throws ApiException, InterruptedException { + TimeUnit.SECONDS.sleep(bulkRequestDelay); + // For 2000 recipients, it can take about an hour + return bulkEnvelopesApi.getBulkSendBatchStatus(accountId, batchId); + } + //ds-snippet-end:eSign31Step7 + + public static String bulkSendEnvelopes( + BulkEnvelopesApi bulkEnvelopesApi, + ApiClient apiClient, + String signerName, + String signerEmail, + String ccName, + String ccEmail, + String signerName2, + String signerEmail2, + String ccName2, + String ccEmail2, + String accountId + ) throws ApiException, IOException { + BulkSendingList sendingList = BulkSendEnvelopesService.getSendingList( + signerName, + signerEmail, + ccName, + ccEmail, + signerName2, + signerEmail2, + ccName2, + ccEmail2 + ); + + String bulkListId = bulkEnvelopesApi.createBulkSendList(accountId, sendingList).getListId(); + + // Create an envelope + //ds-snippet-start:eSign31Step4 + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + String envelopeId = envelopesApi.createEnvelope(accountId, makeEnvelope()).getEnvelopeId(); + //ds-snippet-end:eSign31Step4 + + // Attach your bulk list ID to the envelope + //ds-snippet-start:eSign31Step5 + CustomFields customFields = createCustomFields(bulkListId); + envelopesApi.createCustomFields(accountId, envelopeId, customFields); + //ds-snippet-end:eSign31Step5 + + // Initiate bulk send + //ds-snippet-start:eSign31Step6 + BulkSendRequest request = new BulkSendRequest(); + request.setEnvelopeOrTemplateId(envelopeId); + return bulkEnvelopesApi.createBulkSendRequest(accountId, bulkListId, request).getBatchId(); + //ds-snippet-end:eSign31Step6 + } + +//ds-snippet-start:eSign31Step3 + public static BulkSendingList getSendingList( + String signerName, + String signerEmail, + String ccName, + String ccEmail, + String signerName2, + String signerEmail2, + String ccName2, + String ccEmail2 + ) { + List copies = List.of( + createBulkSending(signerName, signerEmail, ccName, ccEmail), + createBulkSending(signerName2, signerEmail2, ccName2, ccEmail2) + ); + return new BulkSendingList() + .name("sample.csv") + .bulkCopies(copies); + } + + public static BulkSendingCopy createBulkSending( + String signerName, + String signerEmail, + String ccName, + String ccEmail + ) { + BulkSendingCopyRecipient recipient1 = new BulkSendingCopyRecipient() + .name(signerName) + .email(signerEmail) + .tabs(Collections.emptyList()) + .roleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + BulkSendingCopyRecipient recipient2 = new BulkSendingCopyRecipient() + .name(ccName) + .email(ccEmail) + .tabs(Collections.emptyList()) + .roleName(EnvelopeHelpers.CC_ROLE_NAME); + return new BulkSendingCopy() + .recipients(List.of(recipient1, recipient2)) + .customFields(Collections.emptyList()); + } +//ds-snippet-end:eSign31Step3 + + public static EnvelopeDefinition makeEnvelope() throws IOException { + Document document = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); + return new EnvelopeDefinition() + .documents(List.of(document)) + .envelopeIdStamping(DsModelUtils.TRUE) + .emailSubject("EG031 Please sign") + .status(EnvelopeHelpers.ENVELOPE_STATUS_CREATED) + .recipients(createRecipients()); + } + + public static CustomFields createCustomFields(String bulkListId) { + TextCustomField textCustomField = new TextCustomField() + .name("mailingListId") + .required(DsModelUtils.FALSE) + .show(DsModelUtils.FALSE) + .value(bulkListId); + + return new CustomFields() + .listCustomFields(Collections.emptyList()) + .textCustomFields(List.of(textCustomField)); + } + + public static Recipients createRecipients() { + Signer signer = createSignerPlaceholder(EnvelopeHelpers.SIGNER_ROLE_NAME, "1", "1"); + CarbonCopy cc = createCCPlaceholder(EnvelopeHelpers.CC_ROLE_NAME, "2", "2"); + return new Recipients() + .signers(List.of(signer)) + .carbonCopies(List.of(cc)); + } + + public static Signer createSignerPlaceholder(String roleName, String recipientId, String routingOrder) { + return new Signer() + .name(String.format(BULK_SIGNER_NAME_PLACEHOLDER, roleName)) + .email(String.format(BULK_SIGNER_EMAIL_PLACEHOLDER, roleName)) + .roleName(roleName) + .note("") + .routingOrder(routingOrder) + .status(EnvelopeHelpers.SIGNER_STATUS_CREATED) + .deliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL) + .recipientId(recipientId) + .recipientType(roleName) + .tabs(EnvelopeHelpers.createSingleSignerTab("/sn1/", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X)); + } + + public static CarbonCopy createCCPlaceholder(String roleName, String recipientId, String routingOrder) { + return new CarbonCopy() + .name(String.format(BULK_SIGNER_NAME_PLACEHOLDER, roleName)) + .email(String.format(BULK_SIGNER_EMAIL_PLACEHOLDER, roleName)) + .roleName(roleName) + .note("") + .routingOrder(routingOrder) + .status(EnvelopeHelpers.SIGNER_STATUS_CREATED) + .deliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL) + .recipientId(recipientId) + .recipientType(roleName); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/CfrEmbeddedSigningService.java b/src/main/java/com/docusign/controller/eSignature/services/CfrEmbeddedSigningService.java new file mode 100644 index 00000000..9aef1c23 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/CfrEmbeddedSigningService.java @@ -0,0 +1,123 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.DSConfiguration; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; + +public final class CfrEmbeddedSigningService { + //ds-snippet-start:eSign41Step6 + public static ViewUrl embeddedSigning( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId, + RecipientViewRequest viewRequest + ) throws ApiException { + return envelopesApi.createRecipientView(accountId, envelopeId, viewRequest); + } + //ds-snippet-end:eSign41Step6 + + //ds-snippet-start:eSign41Step5 + public static RecipientViewRequest makeRecipientViewRequest( + String signerEmail, + String signerName, + DSConfiguration config, + String clientUserId + ) { + RecipientViewRequest viewRequest = new RecipientViewRequest(); + // Set the url where you want the recipient to go once they are done signing + // should typically be a callback route somewhere in your app. + // The query parameter is included as an example of how + // to save/recover state information during the redirect to + // the DocuSign signing. It's usually better to use + // the session mechanism of your web framework. Query parameters + // can be changed/spoofed very easily. + String stateValue = "?state=123"; + viewRequest.setReturnUrl(config.getDsReturnUrl() + stateValue); + + // How has your app authenticated the user? In addition to your app's + // authentication, you can include authenticate steps from DocuSign. + // Eg, SMS authentication + String authenticationMethod = "none"; + viewRequest.setAuthenticationMethod(authenticationMethod); + + // Recipient information must match embedded recipient info + // we used to create the envelope. + viewRequest.setEmail(signerEmail); + viewRequest.setUserName(signerName); + viewRequest.setClientUserId(clientUserId); + + // DocuSign recommends that you redirect to DocuSign for the + // embedded signing. There are multiple ways to save state. + // To maintain your application's session, use the pingUrl + // parameter. It causes the DocuSign signing web page + // (not the DocuSign server) to send pings via AJAX to your app. + // NOTE: The pings will only be sent if the pingUrl is an https address + String pingFrequency = "600"; + viewRequest.setPingFrequency(pingFrequency); // seconds + viewRequest.setPingUrl(config.getDsPingUrl()); + + return viewRequest; + } + //ds-snippet-end:eSign41Step5 + + //ds-snippet-start:eSign41Step3 + public static EnvelopeDefinition makeEnvelope( + String signerName, + String signerEmail, + String countryCode, + String number, + String workflowId, + String signerClientId, + Integer anchorOffsetY, + Integer anchorOffsetX, + String documentFileName, + String documentName + ) throws IOException { + // Create a signer recipient to sign the document, identified by name and email + // We set the clientUserId to enable embedded signing for the recipient + RecipientIdentityPhoneNumber phoneNumber = new RecipientIdentityPhoneNumber(); + phoneNumber.setCountryCode(countryCode); + phoneNumber.setNumber(number); + + RecipientIdentityInputOption inputOption = new RecipientIdentityInputOption(); + inputOption.setName("phone_number_list"); + inputOption.setValueType("PhoneNumberList"); + inputOption.setPhoneNumberList(List.of(phoneNumber)); + + RecipientIdentityVerification identityVerifcation = new RecipientIdentityVerification(); + + identityVerifcation.setWorkflowId(workflowId); + identityVerifcation.setInputOptions(List.of(inputOption)); + + Signer signer = new Signer(); + signer.setEmail(signerEmail); + signer.setName(signerName); + signer.clientUserId(signerClientId); + signer.recipientId("1"); + signer.setTabs(EnvelopeHelpers.createSingleSignerTab("/sn1/", anchorOffsetY, anchorOffsetX)); + signer.setIdentityVerification(identityVerifcation); + + // Add the recipient to the envelope object + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); + envelopeDefinition.setEmailSubject("Please sign this document"); + envelopeDefinition.setRecipients(recipients); + Document doc = EnvelopeHelpers.createDocumentFromFile(documentFileName, documentName, "3"); + envelopeDefinition.setDocuments(Collections.singletonList(doc)); + // Request that the envelope be sent by setting |status| to "sent". + // To request that the envelope be created as a draft, set to "created" + envelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + return envelopeDefinition; + } + //ds-snippet-end:eSign41Step3 +} diff --git a/src/main/java/com/docusign/controller/examples/EG014ControllerCollectPayment.java b/src/main/java/com/docusign/controller/eSignature/services/CollectPaymentService.java similarity index 63% rename from src/main/java/com/docusign/controller/examples/EG014ControllerCollectPayment.java rename to src/main/java/com/docusign/controller/eSignature/services/CollectPaymentService.java index 6c2fe0ad..0ba9e689 100644 --- a/src/main/java/com/docusign/controller/examples/EG014ControllerCollectPayment.java +++ b/src/main/java/com/docusign/controller/eSignature/services/CollectPaymentService.java @@ -1,102 +1,51 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.services; -import com.docusign.DSConfiguration; -import com.docusign.common.DocumentType; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.core.common.DocumentType; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.CarbonCopy; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.FormulaTab; -import com.docusign.esign.model.List; -import com.docusign.esign.model.ListItem; -import com.docusign.esign.model.PaymentDetails; -import com.docusign.esign.model.PaymentLineItem; -import com.docusign.esign.model.Signer; -import com.docusign.esign.model.Tabs; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; +import com.docusign.esign.model.*; + import java.io.IOException; +import java.nio.charset.StandardCharsets; import java.util.Arrays; +import java.util.Collections; -import javax.servlet.http.HttpServletResponse; - - -/** - * Send an envelope with an order form, including a payment field.
- * This class programmatically constructs the order form. For many use cases, - * it would be better to create the order form as a template using the DocuSign - * web tool as a WYSIWYG form designer.
- * Note: This example will only work if the sender's DocuSign account is - * set up with a DocuSign payment gateway. Next properties should are set: - *
    - *
  • Gateway_Account_Id
    • - *
  • Gateway_Name
    • - *
  • Gateway_Display_Name
    • - *
- * Since the Payment Gateway ID is set in the configuration file, you will need - * to run your own instance of this project to set it. - */ -@Controller -@RequestMapping("/eg014") -public class EG014ControllerCollectPayment extends AbstractController { - - private static final String MODEL_GATEWAY_OK = "gatewayOk"; +public final class CollectPaymentService { private static final String HTML_DOCUMENT_FILE_NAME = "templates/order-form.ftl"; + private static final String HTML_DOCUMENT_NAME = "Order form"; + // Order form constants private static final String TRUE = "true"; + private static final String FALSE = "false"; - private static final int L1_PRICE = 5; - private static final int L2_PRICE = 150; - private static final int ANCHOR_OFFSET_Y = 10; - private static final int ANCHOR_OFFSET_X = 20; - private static final String DEFAULT_FONT = "helvetica"; - private static final String DEFAULT_FONT_SIZE = "size11"; - private static final String ANCHOR_UNITS = "pixels"; - private final Session session; - private final User user; + private static final int L1_PRICE = 5; + private static final int L2_PRICE = 150; - @Autowired - public EG014ControllerCollectPayment(DSConfiguration config, Session session, User user) { - super(config, "eg014", "Envelope sent"); - this.session = session; - this.user = user; - } + private static final int ANCHOR_OFFSET_Y = 10; - @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { - super.onInitModel(args, model); - model.addAttribute(MODEL_GATEWAY_OK, null != config.getGatewayAccountId()); - } + private static final int ANCHOR_OFFSET_X = 20; - @Override - // ***DS.snippet.0.start - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); + private static final String DEFAULT_FONT = "helvetica"; - // Step 1. Make the envelope request body - EnvelopeDefinition envelope = makeEnvelope(args); + private static final String DEFAULT_FONT_SIZE = "size11"; - // Step 2. call Envelopes::create API method - EnvelopeSummary results = envelopesApi.createEnvelope(session.getAccountId(), envelope); + private static final String ANCHOR_UNITS = "pixels"; - DoneExample.createDefault(title) - .withMessage(String.join("", "The envelope has been created and sent!
Envelope ID ", - results.getEnvelopeId(), ".")) - .addToModel(model); - return DONE_EXAMPLE_PAGE; + //ds-snippet-start:eSign14Step4 + public static EnvelopeSummary collectPayment( + EnvelopesApi envelopesApi, + EnvelopeDefinition envelope, + String accountId + ) throws ApiException { + // Call Envelopes::create API method + return envelopesApi.createEnvelope(accountId, envelope); } - + //ds-snippet-end:eSign14Step4 // document 1 (html) has multiple tags: // /l1q/ and /l2q/ -- quantities: drop down // /l1e/ and /l2e/ -- extended: payment lines @@ -107,24 +56,36 @@ protected Object doWork(WorkArguments args, ModelMap model, // recipient 2 - cc // The envelope will be sent first to the signer. // After it is signed, a copy is sent to the cc person. - private EnvelopeDefinition makeEnvelope(WorkArguments args) throws IOException { - byte[] htmlDoc = EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args); + //ds-snippet-start:eSign14Step3 + + public static EnvelopeDefinition makeEnvelope( + String signerEmail, + String signerName, + String ccName, + String ccEmail, + String gatewayAccountId, + String gatewayName, + String gatewayDisplayName, + WorkArguments args + ) throws IOException { + byte[] htmlDoc = EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args) + .getBytes(StandardCharsets.UTF_8); // create a signer recipient to sign the document, identified by name and email // 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. Signer signer = new Signer() - .email(args.getSignerEmail()) - .name(args.getSignerName()) + .email(signerEmail) + .name(signerName) .recipientId("1") .routingOrder("1"); - signer.setTabs(createTabs()); + signer.setTabs(createTabs(gatewayAccountId, gatewayName, gatewayDisplayName)); // create a cc recipient to receive a copy of the documents, identified by name and email CarbonCopy cc = new CarbonCopy() - .email(args.getCcEmail()) - .name(args.getCcName()) + .email(ccEmail) + .name(ccName) .routingOrder("2") .recipientId("2"); @@ -133,7 +94,7 @@ private EnvelopeDefinition makeEnvelope(WorkArguments args) throws IOException { // To request that the envelope be created as a draft, set to "created" EnvelopeDefinition envelope = new EnvelopeDefinition(); envelope.setEmailSubject("Please complete your order"); - envelope.setDocuments(Arrays.asList(EnvelopeHelpers.createDocument(htmlDoc, + envelope.setDocuments(Collections.singletonList(EnvelopeHelpers.createDocument(htmlDoc, HTML_DOCUMENT_NAME, DocumentType.HTML.getDefaultFileExtention(), "1"))); envelope.setRecipients(EnvelopeHelpers.createRecipients(signer, cc)); envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); @@ -142,7 +103,7 @@ private EnvelopeDefinition makeEnvelope(WorkArguments args) throws IOException { } // creates tabs per signer - private Tabs createTabs() { + private static Tabs createTabs(String gatewayAccountId, String gatewayName, String gatewayDisplayName) { java.util.List listItems = java.util.List.of( new ListItem().text("none").value("0"), new ListItem().text("1").value("1"), @@ -184,10 +145,10 @@ private Tabs createTabs() { .description(String.format("${%d} each", L2_PRICE)) .amountReference("l2e"); PaymentDetails paymentDetails = new PaymentDetails() - .gatewayAccountId(config.getGatewayAccountId()) + .gatewayAccountId(gatewayAccountId) .currencyCode("USD") - .gatewayName(config.getGatewayName()) - .gatewayDisplayName(config.getGatewayDisplayName()) + .gatewayName(gatewayName) + .gatewayDisplayName(gatewayDisplayName) .lineItems(Arrays.asList(paymentLineIteml1, paymentLineIteml2)); // Hidden formula for the payment itself FormulaTab formulaPayment = new FormulaTab() @@ -237,5 +198,5 @@ private static FormulaTab createFormulaTab(String anchor, String label, int pric .locked(TRUE) .disableAutoSize(FALSE); } - // ***DS.snippet.0.end + //ds-snippet-end:eSign14Step3 } diff --git a/src/main/java/com/docusign/controller/eSignature/services/CreateBrandService.java b/src/main/java/com/docusign/controller/eSignature/services/CreateBrandService.java new file mode 100644 index 00000000..433b07ee --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/CreateBrandService.java @@ -0,0 +1,27 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.Brand; +import com.docusign.esign.model.BrandsResponse; + +import java.util.List; + +public final class CreateBrandService { + public static BrandsResponse createBrand( + AccountsApi accountsApi, + String brandName, + String language, + String accountId + ) throws ApiException { + Brand brand = new Brand() + .brandName(brandName) + .defaultBrandLanguage(language) + .brandLanguages(List.of(language)); + + // Step 4. Call the eSignature REST API + //ds-snippet-start:eSign28Step4 + return accountsApi.createBrand(accountId, brand); + //ds-snippet-end:eSign28Step4 + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG008ControllerCreateTemplate.java b/src/main/java/com/docusign/controller/eSignature/services/CreateTemplateService.java similarity index 55% rename from src/main/java/com/docusign/controller/examples/EG008ControllerCreateTemplate.java rename to src/main/java/com/docusign/controller/eSignature/services/CreateTemplateService.java index 0521ac6e..b02b56bc 100644 --- a/src/main/java/com/docusign/controller/examples/EG008ControllerCreateTemplate.java +++ b/src/main/java/com/docusign/controller/eSignature/services/CreateTemplateService.java @@ -1,96 +1,45 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.services; -import com.docusign.DSConfiguration; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; import com.docusign.esign.api.TemplatesApi; import com.docusign.esign.client.ApiClient; import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.CarbonCopy; -import com.docusign.esign.model.Checkbox; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.EnvelopeTemplate; -import com.docusign.esign.model.EnvelopeTemplateResults; -import com.docusign.esign.model.List; -import com.docusign.esign.model.ListItem; -import com.docusign.esign.model.Radio; -import com.docusign.esign.model.RadioGroup; -import com.docusign.esign.model.SignHere; -import com.docusign.esign.model.Signer; -import com.docusign.esign.model.Tabs; -import com.docusign.esign.model.TemplateSummary; -import com.docusign.esign.model.Text; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; +import com.docusign.esign.model.*; import java.io.IOException; import java.util.Arrays; +import java.util.Collections; import java.util.Locale; -import javax.servlet.http.HttpServletResponse; - - -/** - * Create a template.
- * Create a template with two roles, signer and cc. The template - * includes three documents. - */ -@Controller -@RequestMapping("/eg008") -public class EG008ControllerCreateTemplate extends AbstractController { - - private static final String TEMPLATE_NAME = "Example Signer and CC template"; +public final class CreateTemplateService { private static final String PDF_DOCUMENT_FILE_NAME = "World_Wide_Corp_fields.pdf"; + private static final String PDF_DOCUMENT_NAME = "Lorem Ipsum"; + private static final String DOCUMENT_ID = "1"; - private static final String PAGE_NUMBER = "1"; - private static final String FALSE = "false"; - private final Session session; - private final User user; + private static final String PAGE_NUMBER = "1"; + private static final String FALSE = "false"; - @Autowired - public EG008ControllerCreateTemplate(DSConfiguration config, Session session, User user) { - super(config, "eg008", "Create a template"); - this.session = session; - this.user = user; + public static TemplateSummary createTemplate( + ApiClient apiClient, + String accountId, + EnvelopeTemplate envelopeTemplate + ) throws ApiException { + TemplatesApi templatesApi = new TemplatesApi(apiClient); + return templatesApi.createTemplate(accountId, envelopeTemplate); } - @Override - // ***DS.snippet.0.start - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - // Step 1. list existing templates - ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); + public static EnvelopeTemplateResults searchTemplatesByName( + ApiClient apiClient, + String accountId, + String templateName + ) throws ApiException { TemplatesApi templatesApi = new TemplatesApi(apiClient); TemplatesApi.ListTemplatesOptions options = templatesApi.new ListTemplatesOptions(); - options.setSearchText(TEMPLATE_NAME); - String accountId = session.getAccountId(); - EnvelopeTemplateResults results = templatesApi.listTemplates(accountId, options); - - // Step 2. Process results. If template do not exist, create one - if (Integer.parseInt(results.getResultSetSize()) > 0) { - EnvelopeTemplate template = results.getEnvelopeTemplates().get(0); - DoneExample.createDefault(title) - .withMessage(String.format( - "The template already exists in your account.
Template name: %s, ID %s.", - template.getName(), template.getTemplateId())) - .addToModel(model); - } else { - session.setTemplateName(TEMPLATE_NAME); - TemplateSummary template = templatesApi.createTemplate(accountId, makeTemplate()); - DoneExample.createDefault(title) - .withMessage(String.format( - "The template has been created!
Template name: %s, ID %s.", - template.getName(), template.getTemplateId())) - .addToModel(model); - } - - return DONE_EXAMPLE_PAGE; + options.setSearchText(templateName); + return templatesApi.listTemplates(accountId, options); } // document 1 (pdf) has tag /sn1/ @@ -100,7 +49,8 @@ protected Object doWork(WorkArguments args, ModelMap model, // recipient 2 - cc // The template will be sent first to the signer. // After it is signed, a copy is sent to the cc person. - private EnvelopeTemplate makeTemplate() throws IOException { + //ds-snippet-start:eSign8Step2 + public static EnvelopeTemplate makeTemplate(String templateName) throws IOException { Document doc = EnvelopeHelpers.createDocumentFromFile(PDF_DOCUMENT_FILE_NAME, PDF_DOCUMENT_NAME, "1"); // Tabs are set per recipient / signer @@ -110,12 +60,13 @@ private EnvelopeTemplate makeTemplate() throws IOException { createCheckbox("ckAuthentication", "75", "447"), createCheckbox("ckAgreement", "75", "478"), createCheckbox("ckAcknowledgement", "75", "508"))); - signer1Tabs.setListTabs(Arrays.asList(createList())); - signer1Tabs.setRadioGroupTabs(Arrays.asList(createRadioGroup())); - signer1Tabs.setSignHereTabs(Arrays.asList(createSignHere())); - signer1Tabs.textTabs(Arrays.asList( - createText("text", "153", "230"), - createText("numbersOnly", "153", "260"))); + signer1Tabs.setListTabs(Collections.singletonList(createList())); + signer1Tabs.setRadioGroupTabs(Collections.singletonList(createRadioGroup())); + signer1Tabs.setSignHereTabs(Collections.singletonList(createSignHere())); + signer1Tabs.textTabs(java.util.List.of( + createText("text", "153", "230"))); + signer1Tabs.numericalTabs(java.util.List.of( + createNumerical("numericalCurrency", "153", "260"))); // create a signer recipient to sign the document, identified by name and email // routingOrder (lower means earlier) determines the order of deliveries @@ -136,9 +87,9 @@ private EnvelopeTemplate makeTemplate() throws IOException { // Create the overall template definition. The order in the docs array // determines the order in the envelope. EnvelopeTemplate template = new EnvelopeTemplate(); - template.setDocuments(Arrays.asList(doc)); + template.setDocuments(Collections.singletonList(doc)); template.setEmailSubject("Please sign this document"); - template.setName(session.getTemplateName()); + template.setName(templateName); template.setDescription("Example template created via the API"); template.setShared(FALSE); template.setRecipients(EnvelopeHelpers.createRecipients(signer, cc1)); @@ -147,7 +98,7 @@ private EnvelopeTemplate makeTemplate() throws IOException { return template; } - private static List createList() { + public static List createList() { List list = new List(); list.setDocumentId(DOCUMENT_ID); list.setPageNumber(PAGE_NUMBER); @@ -169,14 +120,14 @@ private static List createList() { return list; } - private static ListItem createListItem(String color) { + public static ListItem createListItem(String color) { ListItem item = new ListItem(); item.setText(color); item.setValue(color.toLowerCase(Locale.ENGLISH)); return item; } - private static RadioGroup createRadioGroup() { + public static RadioGroup createRadioGroup() { RadioGroup radioGroup = new RadioGroup(); radioGroup.setDocumentId(DOCUMENT_ID); radioGroup.setGroupName("radio1"); @@ -189,7 +140,7 @@ private static RadioGroup createRadioGroup() { return radioGroup; } - private static Radio createRadio(String value, String xPosition) { + public static Radio createRadio(String value, String xPosition) { Radio radio = new Radio(); radio.setPageNumber(PAGE_NUMBER); radio.setValue(value); @@ -199,7 +150,7 @@ private static Radio createRadio(String value, String xPosition) { return radio; } - private static Checkbox createCheckbox(String label, String xPosition, String yPosition) { + public static Checkbox createCheckbox(String label, String xPosition, String yPosition) { Checkbox check = new Checkbox(); check.setDocumentId(DOCUMENT_ID); check.setPageNumber(PAGE_NUMBER); @@ -209,7 +160,7 @@ private static Checkbox createCheckbox(String label, String xPosition, String yP return check; } - private static Text createText(String label, String xPosition, String yPosition) { + public static Text createText(String label, String xPosition, String yPosition) { Text text = new Text(); text.setDocumentId(DOCUMENT_ID); text.setPageNumber(PAGE_NUMBER); @@ -224,7 +175,23 @@ private static Text createText(String label, String xPosition, String yPosition) return text; } - private static SignHere createSignHere() { + public static Numerical createNumerical(String label, String xPosition, String yPosition) { + Numerical numerical = new Numerical(); + numerical.setValidationType("Currency"); + numerical.setDocumentId(DOCUMENT_ID); + numerical.setPageNumber(PAGE_NUMBER); + numerical.setXPosition(xPosition); + numerical.setYPosition(yPosition); + numerical.setFont("helvetica"); + numerical.setFontSize("size14"); + numerical.setTabLabel(label); + numerical.setHeight("23"); + numerical.setWidth("84"); + numerical.setRequired(FALSE); + return numerical; + } + + public static SignHere createSignHere() { SignHere signHere = new SignHere(); signHere.setDocumentId(DOCUMENT_ID); signHere.setPageNumber(PAGE_NUMBER); @@ -232,5 +199,5 @@ private static SignHere createSignHere() { signHere.setYPosition("148"); return signHere; } - // ***DS.snippet.0.end + //ds-snippet-end:eSign8Step2 } diff --git a/src/main/java/com/docusign/controller/eSignature/services/DelayedRoutingService.java b/src/main/java/com/docusign/controller/eSignature/services/DelayedRoutingService.java new file mode 100644 index 00000000..9fc78c5a --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/DelayedRoutingService.java @@ -0,0 +1,107 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Arrays; +import java.util.List; + +public class DelayedRoutingService { + private static final String PDF_DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String PDF_DOCUMENT_NAME = "Lorem Ipsum"; + + private static final String DOCX_DOCUMENT_FILE_NAME = "World_Wide_Corp_Battle_Plan_Trafalgar.docx"; + + private static final String DOCX_DOCUMENT_NAME = "Battle Plan"; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + + private static final int ANCHOR_OFFSET_X_2 = 120; + + // document 1 (docx) has tag /sn1/ + // document 2 (pdf) has tag /sn1/ + // + // The envelope has two recipients. + // recipient 1 - signer + // recipient 2 - cc + // The envelope will be sent first to the signer. After it is signed, + // a copy is sent to the cc person. + public static EnvelopeDefinition makeEnvelope( + String signerName, + String signerEmail, + String signerName2, + String signerEmail2, + String delay, + String status) throws IOException { + // The DocuSign platform searches throughout your envelope's documents + // for matching anchor strings. So the signHere2 tab will be used in + // both document 2 and 3 since they use the same anchor string for + // their "signer 1" tabs. + + //ds-snippet-start:eSign36Step2 + Tabs signer1Tabs = EnvelopeHelpers.createSignerTabs( + EnvelopeHelpers.createSignHere("/sn1/", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X)); + + Tabs signer2Tabs = EnvelopeHelpers.createSignerTabs( + EnvelopeHelpers.createSignHere("/sn1/", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X_2)); + + // Create a signer recipient to sign the document, identified by name + // and email. We're setting the parameters via the object creation. + // 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. + Signer signer = new Signer(); + signer.setEmail(signerEmail); + signer.setName(signerName); + signer.setRecipientId("1"); + signer.setRoutingOrder("1"); + signer.setTabs(signer1Tabs); + + Signer signer2 = new Signer(); + signer2.setEmail(signerEmail2); + signer2.setName(signerName2); + signer2.setRecipientId("2"); + signer2.setRoutingOrder("2"); + signer2.setTabs(signer2Tabs); + + // The order in the docs array determines the order in the envelope + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("Please sign this document set"); + envelope.setDocuments(Arrays.asList( + EnvelopeHelpers.createDocumentFromFile(DOCX_DOCUMENT_FILE_NAME, DOCX_DOCUMENT_NAME, "2"), + EnvelopeHelpers.createDocumentFromFile(PDF_DOCUMENT_FILE_NAME, PDF_DOCUMENT_NAME, "3"))); + envelope.setRecipients(EnvelopeHelpers.createTwoSigners(signer, signer2)); + + // Add the workflow to delay the second recipient + + String delayFormatted = delay + ":00:00"; + EnvelopeDelayRule rule = new EnvelopeDelayRule(); + rule.setDelay(delayFormatted); + + DelayedRouting delayedRouting = new DelayedRouting(); + delayedRouting.setRules(List.of(rule)); + + WorkflowStep workflowStep = new WorkflowStep(); + workflowStep.setAction("pause_before"); + workflowStep.setTriggerOnItem("routing_order"); + workflowStep.setItemId("2"); + workflowStep.setStatus("pending"); + workflowStep.setDelayedRouting(delayedRouting); + + Workflow workflow = new Workflow(); + workflow.setWorkflowSteps(List.of(workflowStep)); + envelope.setWorkflow(workflow); + + // Request that the envelope be sent by setting |status| to "sent". + // To request that the envelope be created as a draft, set to "created" + envelope.setStatus(status); + + return envelope; + //ds-snippet-end:eSign36Step2 + + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/DocumentGenerationService.java b/src/main/java/com/docusign/controller/eSignature/services/DocumentGenerationService.java new file mode 100644 index 00000000..2d985e01 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/DocumentGenerationService.java @@ -0,0 +1,226 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.api.TemplatesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; + +/** + * Document generation code example + */ +public final class DocumentGenerationService { + public static final String CANDIDATE_NAME = "Candidate_Name"; + + public static final String MANAGER_NAME = "Manager_Name"; + + public static final String JOB_TITLE = "Job_Title"; + + public static final String SALARY = "Salary"; + + public static final String START_DATE = "Start_Date"; + + public static final String TEXT_BOX = "TextBox"; + + public static final String STRING_TRUE = "true"; + + public static final String ANCHOR_UNITS = "pixels"; + + public static final String DEFAULT_ID = "1"; + + public static DateSigned createDateSigned() { + DateSigned dateSigned = new DateSigned(); + + dateSigned.setAnchorString("Date"); + dateSigned.setAnchorUnits(ANCHOR_UNITS); + dateSigned.setAnchorYOffset("-22"); + + return dateSigned; + } + + // Step 3b start + private static EnvelopeDefinition addDocumentTemplate(String offerDocDocx) throws IOException { + String documentName = "OfferLetterDemo.docx"; + Document document = EnvelopeHelpers.createDocumentFromFile(offerDocDocx, documentName, DEFAULT_ID); + document.setOrder("1"); + document.pages("1"); + + EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); + envelopeDefinition.setDocuments(Collections.singletonList(document)); + + return envelopeDefinition; + } + + public String generateDocument( + String accountId, + String candidateEmail, + String candidateName, + String managerName, + String jobTitle, + String salary, + String startDate, + String offerDocDocx, + EnvelopesApi envelopesApi, + TemplatesApi templatesApi + ) throws ApiException, IOException { + // Step 2a start + TemplateSummary template = templatesApi.createTemplate(accountId, makeTemplate()); + String templateId = template.getTemplateId(); + // Step 2a end + + // Step 3a start + templatesApi.updateDocument(accountId, templateId, DEFAULT_ID, addDocumentTemplate(offerDocDocx)); + // Step 3a end + + // Step 4a start + templatesApi.createTabs(accountId, templateId, DEFAULT_ID, prepareTabs()); + // Step 4a end + + // Step 5a start + EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope( + accountId, + makeEnvelope(candidateEmail, candidateName, template.getTemplateId())); + String envelopeId = envelopeSummary.getEnvelopeId(); + // Step 5a end + + // Step 6 start + DocGenFormFieldResponse formFieldResponse = envelopesApi.getEnvelopeDocGenFormFields(accountId, envelopeId); + String documentId = ""; + if (!formFieldResponse.getDocGenFormFields().isEmpty()) { + DocGenFormFields docGenFormFields = formFieldResponse.getDocGenFormFields().get(0); + if (docGenFormFields != null) { + documentId = docGenFormFields.getDocumentId(); + } + } + // Step 6 end + // Step 7a start + DocGenFormFieldRequest formFields = getFormFields( + documentId, + candidateName, + managerName, + jobTitle, + salary, + startDate); + + envelopesApi.updateEnvelopeDocGenFormFields(accountId, envelopeId, formFields); + // Step 7a end + + // Step 8 start + Envelope envelope = new Envelope(); + envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + EnvelopeUpdateSummary envelopeUpdateSummary = envelopesApi.update(accountId, envelopeId, envelope); + // Step 8 end + return envelopeUpdateSummary.getEnvelopeId(); + } + + // Step 4b start + private TemplateTabs prepareTabs() { + SignHere signHere = createSignHere(); + DateSigned dateSigned = createDateSigned(); + + TemplateTabs templateTabs = new TemplateTabs(); + templateTabs.setSignHereTabs(Collections.singletonList(signHere)); + templateTabs.setDateSignedTabs(Collections.singletonList(dateSigned)); + + return templateTabs; + } + // Step 4b end + + private SignHere createSignHere() { + SignHere signHere = new SignHere(); + + signHere.setAnchorString("Employee Signature"); + signHere.setAnchorUnits(ANCHOR_UNITS); + signHere.setAnchorXOffset("5"); + signHere.setAnchorYOffset("-22"); + + return signHere; + } + // Step 7b end + + // Step 7b start + private DocGenFormFieldRequest getFormFields( + String documentId, + String candidateName, + String managerName, + String jobTitle, + String salary, + String startDate) { + DocGenFormField candidateNameField = new DocGenFormField(); + candidateNameField.setName(CANDIDATE_NAME); + candidateNameField.setValue(candidateName); + + DocGenFormField managerNameField = new DocGenFormField(); + managerNameField.setName(MANAGER_NAME); + managerNameField.setValue(managerName); + + DocGenFormField jobTitleField = new DocGenFormField(); + jobTitleField.setName(JOB_TITLE); + jobTitleField.setValue(jobTitle); + + DocGenFormField salaryField = new DocGenFormField(); + salaryField.setName(SALARY); + salaryField.setValue(salary); + + DocGenFormField startDateField = new DocGenFormField(); + startDateField.setName(START_DATE); + startDateField.setValue(startDate); + + DocGenFormFields formFields = new DocGenFormFields(); + formFields.setDocGenFormFieldList(Arrays.asList( + candidateNameField, + managerNameField, + jobTitleField, + salaryField, + startDateField)); + formFields.setDocumentId(documentId); + + DocGenFormFieldRequest docGenFormFieldRequest = new DocGenFormFieldRequest(); + docGenFormFieldRequest.setDocGenFormFields(Collections.singletonList(formFields)); + + return docGenFormFieldRequest; + } + // Step 5b end + + // Step 5b start + private EnvelopeDefinition makeEnvelope(String candidateEmail, String candidateName, String templateId) { + TemplateRole signerRole = new TemplateRole(); + signerRole.setName(candidateName); + signerRole.setEmail(candidateEmail); + signerRole.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + + EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); + envelopeDefinition.setTemplateRoles(Collections.singletonList(signerRole)); + envelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_CREATED); + envelopeDefinition.setTemplateId(templateId); + + return envelopeDefinition; + } + // Step 2b end + + // Step 2b start + private EnvelopeTemplate makeTemplate() { + Signer signer = new Signer(); + signer.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + signer.setRecipientId(DEFAULT_ID); + signer.setRoutingOrder("1"); + + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + EnvelopeTemplate template = new EnvelopeTemplate(); + template.setEmailSubject("Please sign this document"); + template.setName("Example Template"); + template.setDescription("Example template created via the API"); + template.setRecipients(recipients); + template.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_CREATED); + + return template; + } + // Step 3b stop +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/EmbeddedConsoleService.java b/src/main/java/com/docusign/controller/eSignature/services/EmbeddedConsoleService.java new file mode 100644 index 00000000..c6ad7e26 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/EmbeddedConsoleService.java @@ -0,0 +1,30 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.ConsoleViewRequest; +import com.docusign.esign.model.ViewUrl; + +public final class EmbeddedConsoleService { + public static ViewUrl createConsoleView( + EnvelopesApi envelopesApi, + String dsReturnUrl, + String envelopeId, + String startingView, + String accountId) throws ApiException { + // Step 1. Create the Console / Web UI view. + // Set the URL where you want the recipient to go once they are finished in + // the Web UI. There are cases where a user will never click "FINISH" within + // the Web UI, you cannot assume control will be passed back to your application. + //ds-snippet-start:eSign12Step2 + ConsoleViewRequest viewRequest = new ConsoleViewRequest(); + viewRequest.setReturnUrl(dsReturnUrl); + if ("envelope".equalsIgnoreCase(startingView) && envelopeId != null) { + viewRequest.setEnvelopeId(envelopeId); + } + + // Step 2. Call the CreateSenderView API + return envelopesApi.createConsoleView(accountId, viewRequest); + //ds-snippet-end:eSign12Step2 + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/EmbeddedSendingService.java b/src/main/java/com/docusign/controller/eSignature/services/EmbeddedSendingService.java new file mode 100644 index 00000000..ccbcf91e --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/EmbeddedSendingService.java @@ -0,0 +1,53 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.ReturnUrlRequest; +import com.docusign.esign.model.ViewUrl; + +import java.io.IOException; + +public final class EmbeddedSendingService { + //ds-snippet-start:eSign11Step3 + public static ViewUrl createSenderView( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId, + String dsReturnUrl + ) throws ApiException { + // Create the sender view. + // Set the url where you want the recipient to go once they are done + // signing should typically be a callback route somewhere in your app. + ReturnUrlRequest viewRequest = new ReturnUrlRequest(); + viewRequest.setReturnUrl(dsReturnUrl); + return envelopesApi.createSenderView(accountId, envelopeId, viewRequest); + } + //ds-snippet-end:eSign11Step3 + + //ds-snippet-start:eSign11Step2 + public static EnvelopeSummary createEnvelopeWithDraftStatus( + EnvelopesApi envelopesApi, + String signerEmail, + String signerName, + String ccEmail, + String ccName, + String status, + WorkArguments args, + String accountId + ) throws IOException, ApiException { + args.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_CREATED); + EnvelopeDefinition env = SigningViaEmailService.makeEnvelope( + signerEmail, + signerName, + ccEmail, + ccName, + status, + args); + return envelopesApi.createEnvelope(accountId, env); + } + //ds-snippet-end:eSign11Step2 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/EmbeddedSigningService.java b/src/main/java/com/docusign/controller/eSignature/services/EmbeddedSigningService.java new file mode 100644 index 00000000..740c518b --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/EmbeddedSigningService.java @@ -0,0 +1,115 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Collections; + +public final class EmbeddedSigningService { + public static ViewUrl embeddedSigning( + ApiClient apiClient, + String accountId, + String envelopeId, + RecipientViewRequest viewRequest + ) throws ApiException { + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + + return envelopesApi.createRecipientView(accountId, envelopeId, viewRequest); + } + + public static String createEnvelope( + ApiClient apiClient, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); + + return envelopeSummary.getEnvelopeId(); + } + + //ds-snippet-start:eSign1Step4 + public static RecipientViewRequest makeRecipientViewRequest( + String signerEmail, + String signerName, + String clientUserId, + String dsReturnURL, + String pingURL + ) { + RecipientViewRequest viewRequest = new RecipientViewRequest(); + // Set the url where you want the recipient to go once they are done signing + // should typically be a callback route somewhere in your app. + // The query parameter is included as an example of how + // to save/recover state information during the redirect to + // the DocuSign signing. It's usually better to use + // the session mechanism of your web framework. Query parameters + // can be changed/spoofed very easily. + String stateValue = "?state=123"; + viewRequest.setReturnUrl(dsReturnURL + stateValue); + + // How has your app authenticated the user? In addition to your app's + // authentication, you can include authenticate steps from DocuSign. + // Eg, SMS authentication + String authenticationMethod = "none"; + viewRequest.setAuthenticationMethod(authenticationMethod); + + // Recipient information must match embedded recipient info + // we used to create the envelope. + viewRequest.setEmail(signerEmail); + viewRequest.setUserName(signerName); + viewRequest.setClientUserId(clientUserId); + + // DocuSign recommends that you redirect to DocuSign for the + // embedded signing. There are multiple ways to save state. + // To maintain your application's session, use the pingUrl + // parameter. It causes the DocuSign signing web page + // (not the DocuSign server) to send pings via AJAX to your app. + // NOTE: The pings will only be sent if the pingUrl is an https address + String pingFrequency = "600"; + viewRequest.setPingFrequency(pingFrequency); // seconds + viewRequest.setPingUrl(pingURL); + + return viewRequest; + } + //ds-snippet-end + + //ds-snippet-start:eSign1Step2 + public static EnvelopeDefinition makeEnvelope( + String signerEmail, + String signerName, + String signerClientId, + Integer anchorOffsetY, + Integer anchorOffsetX, + String documentFileName, + String documentName + ) throws IOException { + // Create a signer recipient to sign the document, identified by name and email + // We set the clientUserId to enable embedded signing for the recipient + Signer signer = new Signer(); + signer.setEmail(signerEmail); + signer.setName(signerName); + signer.clientUserId(signerClientId); + signer.recipientId("1"); + signer.setTabs(EnvelopeHelpers.createSingleSignerTab("/sn1/", anchorOffsetY, anchorOffsetX)); + + // Add the recipient to the envelope object + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); + envelopeDefinition.setEmailSubject("Please sign this document"); + envelopeDefinition.setRecipients(recipients); + Document doc = EnvelopeHelpers.createDocumentFromFile(documentFileName, documentName, "3"); + envelopeDefinition.setDocuments(Collections.singletonList(doc)); + // Request that the envelope be sent by setting |status| to "sent". + // To request that the envelope be created as a draft, set to "created" + envelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + return envelopeDefinition; + } + //ds-snippet-end +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/EnvelopeCustomFieldValuesService.java b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeCustomFieldValuesService.java new file mode 100644 index 00000000..0e7a02bb --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeCustomFieldValuesService.java @@ -0,0 +1,15 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.CustomFieldsEnvelope; + +public final class EnvelopeCustomFieldValuesService { + public static CustomFieldsEnvelope envelopeCustomFieldValues( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId + ) throws ApiException { + return envelopesApi.listCustomFields(accountId, envelopeId); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/EnvelopeDocsService.java b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeDocsService.java new file mode 100644 index 00000000..1a6c9657 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeDocsService.java @@ -0,0 +1,16 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDocumentsResult; + +public final class EnvelopeDocsService { + public static EnvelopeDocumentsResult envelopeDocs( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId + ) throws ApiException { + // Step 1. List the envelope's documents + return envelopesApi.listDocuments(accountId, envelopeId); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/EnvelopeGetDocService.java b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeGetDocService.java new file mode 100644 index 00000000..20afcd4a --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeGetDocService.java @@ -0,0 +1,26 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import org.apache.commons.io.FilenameUtils; + +public final class EnvelopeGetDocService { + + public static byte[] envelopeGetDoc( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId, + String documentId + ) throws ApiException { + //ds-snippet-start:eSign7Step3 + return envelopesApi.getDocument(accountId, envelopeId, documentId); + //ds-snippet-end:eSign7Step3 + } + + public static String addExtension(String fileName, String extension) { + if (FilenameUtils.isExtension(fileName, extension)) { + return fileName; + } + return String.join(".", fileName, extension); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/EnvelopeInfoService.java b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeInfoService.java new file mode 100644 index 00000000..3de6d7c0 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeInfoService.java @@ -0,0 +1,17 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.Envelope; + +//ds-snippet-start:eSign4Step2 +public final class EnvelopeInfoService { + public static Envelope envelopeInfo( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId + ) throws ApiException { + return envelopesApi.getEnvelope(accountId, envelopeId); + } +} +//ds-snippet-end:eSign4Step2 diff --git a/src/main/java/com/docusign/controller/eSignature/services/EnvelopeRecipientsService.java b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeRecipientsService.java new file mode 100644 index 00000000..1d0e3139 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeRecipientsService.java @@ -0,0 +1,15 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.Recipients; + +public final class EnvelopeRecipientsService { + public static Recipients envelopeRecipients( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId + ) throws ApiException { + return envelopesApi.listRecipients(accountId, envelopeId); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/FocusedViewService.java b/src/main/java/com/docusign/controller/eSignature/services/FocusedViewService.java new file mode 100644 index 00000000..7d696fac --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/FocusedViewService.java @@ -0,0 +1,133 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.RecipientViewRequest; +import com.docusign.esign.model.ViewUrl; +import com.docusign.esign.model.Signer; +import com.docusign.esign.model.Recipients; +import com.docusign.esign.model.Document; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; + +public class FocusedViewService { + + private static String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static String DOCUMENT_NAME = "Lorem Ipsum"; + + private static String SIGNER_CLIENT_ID = "1000"; + + private static int ANCHOR_OFFSET_Y = 20; + + private static int ANCHOR_OFFSET_X = 10; + + public static String STATE_123 = "?state=123"; + + public static String AUTHENTICATION_METHOD = "none"; + + public String[] sendEnvelopeWithFocusedView( + String signerEmail, + String signerName, + ApiClient apiClient, + String accountId, + String returnUrl + ) throws ApiException, IOException { + //ds-snippet-start:eSign44Step3 + EnvelopeDefinition envelope = makeEnvelope( + signerEmail, + signerName, + SIGNER_CLIENT_ID, + ANCHOR_OFFSET_Y, + ANCHOR_OFFSET_X, + DOCUMENT_FILE_NAME, + DOCUMENT_NAME); + + EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); + + EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); + + String envelopeId = envelopeSummary.getEnvelopeId(); + //ds-snippet-end:eSign44Step3 + + //ds-snippet-start:eSign44Step5 + RecipientViewRequest viewRequest = makeRecipientViewRequest(signerEmail, signerName, returnUrl, SIGNER_CLIENT_ID, returnUrl); + ViewUrl viewUrl = envelopesApi.createRecipientView(accountId, envelopeId, viewRequest); + String redirectUrl = viewUrl.getUrl(); + + return new String[] { envelopeId, redirectUrl }; + //ds-snippet-end:eSign44Step5 + } + + //ds-snippet-start:eSign44Step4 + public RecipientViewRequest makeRecipientViewRequest( + String signerEmail,String signerName, String returnUrl, String signerClientId, String pingUrl + ) throws ApiException { + String pingFrequency = "600"; + String linkToLauncher = "http://localhost:8080"; + String linkToDocuSignServer = "https://apps-d.docusign.com"; + + RecipientViewRequest viewRequest = new RecipientViewRequest(); + + viewRequest.setReturnUrl(returnUrl + STATE_123); + viewRequest.setAuthenticationMethod(AUTHENTICATION_METHOD); + viewRequest.setEmail(signerEmail); + viewRequest.setUserName(signerName); + viewRequest.setClientUserId(signerClientId); + + if (pingUrl != null) + { + viewRequest.setPingFrequency(pingFrequency); + viewRequest.setPingUrl(pingUrl); + } + + viewRequest.setFrameAncestors(Arrays.asList(new String[]{linkToLauncher, linkToDocuSignServer})); + viewRequest.setMessageOrigins(Arrays.asList(new String[]{linkToDocuSignServer})); + + return viewRequest; + } + //ds-snippet-end:eSign44Step4 + + //ds-snippet-start:eSign44Step2 + public EnvelopeDefinition makeEnvelope( + String signerEmail, + String signerName, + String signerClientId, + Integer anchorOffsetY, + Integer anchorOffsetX, + String documentFileName, + String documentName + ) throws IOException { + String emailSubject = "Please sign this document"; + String recipientId = "1"; + String anchorString = "/sn1/"; + String docId = "3"; + + Signer signer = new Signer(); + signer.setEmail(signerEmail); + signer.setName(signerName); + signer.clientUserId(signerClientId); + signer.recipientId(recipientId); + signer.setTabs(EnvelopeHelpers.createSingleSignerTab(anchorString, anchorOffsetY, anchorOffsetX)); + + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); + envelopeDefinition.setEmailSubject(emailSubject); + envelopeDefinition.setRecipients(recipients); + + Document document = EnvelopeHelpers.createDocumentFromFile(documentFileName, documentName, docId); + envelopeDefinition.setDocuments(Collections.singletonList(document)); + envelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + return envelopeDefinition; + } + //ds-snippet-end:eSign44Step2 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/GetTabValuesService.java b/src/main/java/com/docusign/controller/eSignature/services/GetTabValuesService.java new file mode 100644 index 00000000..4a41e140 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/GetTabValuesService.java @@ -0,0 +1,15 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeFormData; + +public final class GetTabValuesService { + public static EnvelopeFormData getTabValues( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId + ) throws ApiException { + return envelopesApi.getFormData(accountId, envelopeId); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/IdvAuthenticationService.java b/src/main/java/com/docusign/controller/eSignature/services/IdvAuthenticationService.java new file mode 100644 index 00000000..e7c98d92 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/IdvAuthenticationService.java @@ -0,0 +1,101 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Base64; +import java.util.Collections; +import java.util.List; + +public final class IdvAuthenticationService { + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + public static EnvelopeSummary idvAuthentication( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + return envelopesApi.createEnvelope(accountId, envelope); + } + + public static String retrieveWorkflowId(ApiClient apiClient, String accountId) throws ApiException { + //ds-snippet-start:eSign23Step3 + AccountsApi workflowDetails = new AccountsApi(apiClient); + AccountIdentityVerificationResponse workflowRes = workflowDetails.getAccountIdentityVerification(accountId); + List identityVerification = workflowRes.getIdentityVerification(); + String workflowId = ""; + for (int i = 0; i < identityVerification.size(); i++) { + if (identityVerification.get(i).getDefaultName().equals("DocuSign ID Verification")) { + workflowId = identityVerification.get(i).getWorkflowId(); + } + } + return workflowId; + //ds-snippet-end:eSign23Step3 + } + + //ds-snippet-start:eSign23Step4 + public static EnvelopeDefinition createEnvelope( + String signerName, + String signerEmail, + String workflowId + ) { + EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); + envelopeDefinition.setEmailSubject("Please sign"); + envelopeDefinition.setEmailBlurb("Sample text for email body"); + envelopeDefinition.setStatus("Sent"); + + byte[] fileBytes = new byte[0]; + try { + fileBytes = EnvelopeHelpers.readFile(DOCUMENT_FILE_NAME); + } catch (IOException e) { + e.printStackTrace(); + } + Document doc1 = new Document(); + doc1.setDocumentBase64(Base64.getEncoder().encodeToString(fileBytes)); + doc1.setDocumentId("1"); + doc1.setFileExtension("pdf"); + doc1.setName("Lorem"); + + SignHere signHere1 = new SignHere(); + signHere1.setName("SignHereTab"); + signHere1.setXPosition("75"); + signHere1.setYPosition("572"); + signHere1.setTabLabel("SignHereTab"); + signHere1.setPageNumber("1"); + signHere1.setDocumentId("1"); + // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your own systems. + // This value is referenced in the Tabs element below to assign tabs on a per-recipient basis. + signHere1.setRecipientId("1"); //represents your {RECIPIENT_ID} + + Tabs signer1Tabs = new Tabs(); + signer1Tabs.setSignHereTabs(Collections.singletonList(signHere1)); + RecipientIdentityVerification workflow = new RecipientIdentityVerification(); + workflow.setWorkflowId(workflowId); + + String status = "created"; + String deliveryMethod = "email"; + Signer signer1 = new Signer(); + signer1.setName(signerName); + signer1.setEmail(signerEmail); + signer1.setRoleName(""); + signer1.setNote(""); + signer1.setStatus(status); + signer1.setDeliveryMethod(deliveryMethod); + signer1.setRecipientId("1"); //represents your {RECIPIENT_ID} + signer1.setIdentityVerification(workflow); + signer1.setTabs(signer1Tabs); + + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer1)); + + envelopeDefinition.setRecipients(recipients); + envelopeDefinition.setDocuments(Collections.singletonList(doc1)); + return envelopeDefinition; + } + //ds-snippet-end:eSign23Step4 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/InPersonSigningService.java b/src/main/java/com/docusign/controller/eSignature/services/InPersonSigningService.java new file mode 100644 index 00000000..bf01c710 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/InPersonSigningService.java @@ -0,0 +1,77 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.DSConfiguration; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Collections; + +public final class InPersonSigningService { + public static ViewUrl inPersonSigning( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId, + RecipientViewRequest viewRequest + ) throws ApiException { + return envelopesApi.createRecipientView(accountId, envelopeId, viewRequest); + } + + //ds-snippet-start:eSign39Step4 + public static RecipientViewRequest makeRecipientViewRequest( + String hostEmail, + String hostName, + DSConfiguration config) { + String stateValue = "?state=123"; + String authenticationMethod = "none"; + String pingFrequency = "600"; + + RecipientViewRequest viewRequest = new RecipientViewRequest(); + + viewRequest.setReturnUrl(config.getDsReturnUrl() + stateValue); + viewRequest.setAuthenticationMethod(authenticationMethod); + viewRequest.setEmail(hostEmail); + viewRequest.setUserName(hostName); + viewRequest.setPingFrequency(pingFrequency); + viewRequest.setPingUrl(config.getDsPingUrl()); + + return viewRequest; + } + //ds-snippet-end:eSign39Step4 + + //ds-snippet-start:eSign39Step2 + public static EnvelopeDefinition makeEnvelope( + String hostEmail, + String hostName, + String signerName, + Integer anchorOffsetY, + Integer anchorOffsetX, + String documentFileName, + String documentName + ) throws IOException { + InPersonSigner inPersonSigner = new InPersonSigner(); + + inPersonSigner.setHostEmail(hostEmail); + inPersonSigner.setHostName(hostName); + inPersonSigner.setSignerName(signerName); + inPersonSigner.setRecipientId("1"); + inPersonSigner.setRoutingOrder("1"); + inPersonSigner.setTabs(EnvelopeHelpers.createSingleSignerTab("/sn1/", anchorOffsetY, anchorOffsetX)); + + Recipients recipients = new Recipients(); + recipients.setInPersonSigners(Collections.singletonList(inPersonSigner)); + + EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); + envelopeDefinition.setEmailSubject("Please host this in-person signing session"); + envelopeDefinition.setRecipients(recipients); + + Document document = EnvelopeHelpers.createDocumentFromFile(documentFileName, documentName, "1"); + envelopeDefinition.setDocuments(Collections.singletonList(document)); + envelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + return envelopeDefinition; + } + //ds-snippet-end:eSign39Step2 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/KBAAuthenticationService.java b/src/main/java/com/docusign/controller/eSignature/services/KBAAuthenticationService.java new file mode 100644 index 00000000..75dcb907 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/KBAAuthenticationService.java @@ -0,0 +1,77 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Collections; + +public final class KBAAuthenticationService { + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "Lorem"; + + public static EnvelopeSummary kbaAuthentication( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + //ds-snippet-start:eSign22Step4 + return envelopesApi.createEnvelope(accountId, envelope); + //ds-snippet-end:eSign22Step4 + } + + //ds-snippet-start:eSign22Step3 + public static Signer setSignHereAndSignerForEnvelope( + String signerName, + String signerEmail) throws IOException { + Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); + SignHere signHere = new SignHere(); + signHere.setName("SignHereTab"); + signHere.setXPosition("75"); + signHere.setYPosition("572"); + signHere.setTabLabel("SignHereTab"); + signHere.setPageNumber("1"); + signHere.setDocumentId(doc.getDocumentId()); + // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your own systems. + // This value is referenced in the Tabs element below to assign tabs on a per-recipient basis. + signHere.setRecipientId("1"); + + Signer signer = new Signer(); + signer.setName(signerName); + signer.setEmail(signerEmail); + signer.setRoutingOrder("1"); + signer.setStatus(EnvelopeHelpers.SIGNER_STATUS_CREATED); + signer.setDeliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL); + signer.setRecipientId(signHere.getRecipientId()); + signer.setTabs(EnvelopeHelpers.createSignerTabs(signHere)); + + return signer; + } + + public static EnvelopeDefinition createEnvelope( + String signerName, + String signerEmail + ) throws IOException { + Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); + Signer signer = setSignHereAndSignerForEnvelope(signerName, signerEmail); + signer.setIdCheckConfigurationName("ID Check"); + signer.setRequireIdLookup("true"); + + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("Please Sign"); + envelope.setEnvelopeIdStamping("true"); + envelope.setEmailBlurb("Sample text for email body"); + envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + envelope.setDocuments(Collections.singletonList(doc)); + envelope.setRecipients(recipients); + + return envelope; + } + //ds-snippet-end:eSign22Step3 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/ListEnvelopesServices.java b/src/main/java/com/docusign/controller/eSignature/services/ListEnvelopesServices.java new file mode 100644 index 00000000..5b60d934 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/ListEnvelopesServices.java @@ -0,0 +1,19 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.core.utils.DateUtils; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopesInformation; + +import java.time.LocalDate; + +public final class ListEnvelopesServices { + private static final int FROM_DATE_OFFSET_DAYS = 30; + + public static EnvelopesInformation listEnvelopes(EnvelopesApi envelopesApi, String accountId) throws ApiException { + EnvelopesApi.ListStatusChangesOptions options = envelopesApi.new ListStatusChangesOptions(); + LocalDate date = LocalDate.now().minusDays(FROM_DATE_OFFSET_DAYS); + options.setFromDate(DateUtils.DATE_WITH_SLASH.format(date)); + return envelopesApi.listStatusChanges(accountId, options); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/PauseSignatureWorkflowService.java b/src/main/java/com/docusign/controller/eSignature/services/PauseSignatureWorkflowService.java new file mode 100644 index 00000000..929ed4fa --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/PauseSignatureWorkflowService.java @@ -0,0 +1,87 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; + +public final class PauseSignatureWorkflowService { + private static final String DOCUMENT_FILE_NAME = "Welcome.txt"; + + private static final String DOCUMENT_ID = "1"; + + private static final String DOCUMENT_NAME = "Welcome"; + + public static EnvelopeSummary pauseSignatureWorkflow( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + return envelopesApi.createEnvelope(accountId, envelope); + } + + //ds-snippet-start:eSign32Step3 + public static EnvelopeDefinition createEnvelope( + String signerName, + String signerEmail, + String signerName2, + String signerEmail2 + ) throws IOException { + Document document = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, DOCUMENT_ID); + + WorkflowStep workflowStep = new WorkflowStep(); + workflowStep.setAction(EnvelopeHelpers.WORKFLOW_STEP_ACTION_PAUSE); + workflowStep.setTriggerOnItem(EnvelopeHelpers.WORKFLOW_TRIGGER_ROUTING_ORDER); + workflowStep.setItemId("2"); + + Workflow workflow = new Workflow(); + workflow.setWorkflowSteps(Collections.singletonList(workflowStep)); + + SignHere signHere1 = new SignHere(); + signHere1.setName("SignHereTabs"); + signHere1.setXPosition("200"); + signHere1.setYPosition("200"); + signHere1.setTabLabel("Sign Here"); + signHere1.setPageNumber("1"); + signHere1.setDocumentId(document.getDocumentId()); + + Signer signer1 = new Signer(); + signer1.setName(signerName); + signer1.setEmail(signerEmail); + signer1.setRoutingOrder("1"); + signer1.setRecipientId("1"); + signer1.setTabs(EnvelopeHelpers.createSignerTabs(signHere1)); + + SignHere signHere2 = new SignHere(); + signHere2.setName("SignHereTabs"); + signHere2.setXPosition("300"); + signHere2.setYPosition("200"); + signHere2.setTabLabel("Sign Here"); + signHere2.setPageNumber("1"); + signHere2.setDocumentId(document.getDocumentId()); + + Signer signer2 = new Signer(); + signer2.setName(signerName2); + signer2.setEmail(signerEmail2); + signer2.setRoutingOrder("2"); + signer2.setRecipientId("2"); + signer2.setTabs(EnvelopeHelpers.createSignerTabs(signHere2)); + + Recipients recipients = new Recipients(); + recipients.setSigners(Arrays.asList(signer1, signer2)); + + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("EnvelopeWorkflowTest"); + envelope.setDocuments(Collections.singletonList(document)); + envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + envelope.setRecipients(recipients); + envelope.setWorkflow(workflow); + + return envelope; + } + //ds-snippet-end:eSign32Step3 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/PermissionChangeSingleSettingService.java b/src/main/java/com/docusign/controller/eSignature/services/PermissionChangeSingleSettingService.java new file mode 100644 index 00000000..2479c8fd --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/PermissionChangeSingleSettingService.java @@ -0,0 +1,67 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.DsModelUtils; +import com.docusign.core.model.AccountRoleSettingsPatch; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.AccountRoleSettings; +import com.docusign.esign.model.PermissionProfile; +import com.docusign.esign.model.PermissionProfileInformation; +import com.google.gson.Gson; + +import java.util.*; + +public final class PermissionChangeSingleSettingService { + public static PermissionProfile permissionChangeSingleSetting( + AccountsApi accountsApi, + String accountId, + String curProfileId + ) throws ApiException { + // Step 3. Construct your request body + //ds-snippet-start:eSign26Step3 + PermissionProfileInformation permissionsInfo = accountsApi.listPermissions(accountId); + PermissionProfile profile = PermissionChangeSingleSettingService.findProfile( + permissionsInfo.getPermissionProfiles(), curProfileId) + .orElseThrow(NoSuchElementException::new); + //ds-snippet-end:eSign26Step3 + + // Step 4. Call the eSignature REST API + //ds-snippet-start:eSign26Step4 + AccountRoleSettings newSettings = Objects.requireNonNullElse(profile.getSettings(), + DsModelUtils.createDefaultRoleSettings()); + profile.setSettings(PermissionChangeSingleSettingService.changeRandomSettings(newSettings)); + return accountsApi.updatePermissionProfile(accountId, curProfileId, profile); + //ds-snippet-end:eSign26Step4 + } + + public static Optional findProfile(List profiles, String profileId) { + return profiles.stream().filter(p -> p.getPermissionProfileId().equals(profileId)).findFirst(); + } + + // Changes random boolean properties; in a real application, changing properties + // will be read from the page or in a different way + private static AccountRoleSettings changeRandomSettings(AccountRoleSettings settings) { + Gson gson = new Gson(); + String signingUiVersion = "1"; + // Change this value back to: gson.fromJson(gson.toJson(settings), + // AccountRoleSettings.class); + // as soon as the signinguiversion is added back to the swagger spec. + // Also change the type back from AccountRoleSettingsPatch to AccountRoleSettings + AccountRoleSettingsPatch newSettings = gson.fromJson(gson.toJson(settings), AccountRoleSettingsPatch.class); + newSettings.signingUiVersion(signingUiVersion); + Random random = new Random(System.currentTimeMillis()); + + return newSettings.canCreateWorkspaces(randomBool(random)).allowEnvelopeSending(randomBool(random)) + .allowSignerAttachments(randomBool(random)).allowESealRecipients(randomBool(random)) + .allowTaggingInSendAndCorrect(randomBool(random)).allowWetSigningOverride(randomBool(random)) + .enableApiRequestLogging(randomBool(random)).enableRecipientViewingNotifications(randomBool(random)) + .allowSupplementalDocuments(randomBool(random)).disableDocumentUpload(randomBool(random)); + } + + private static String randomBool(Random random) { + if (random.nextBoolean()) { + return DsModelUtils.TRUE; + } + return DsModelUtils.FALSE; + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/PermissionCreateService.java b/src/main/java/com/docusign/controller/eSignature/services/PermissionCreateService.java new file mode 100644 index 00000000..caf0d5e0 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/PermissionCreateService.java @@ -0,0 +1,35 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.DsModelUtils; +import com.docusign.core.model.AccountRoleSettingsPatch; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.AccountRoleSettings; +import com.docusign.esign.model.PermissionProfile; +import com.google.gson.Gson; + +public class PermissionCreateService { + public static PermissionProfile createNewProfile( + AccountsApi accountsApi, + String accountId, + String permissionProfileName + ) throws ApiException { + // Step 3. Construct your request body + // We're extending the AccountSettings class with AccountSettingsPatch to include the signingUIVersion which is missing in the swagger spec at this time. + //ds-snippet-start:eSign24Step3 + Gson gson = new Gson(); + String signingUiVersion = "1"; + AccountRoleSettings settings = DsModelUtils.createDefaultRoleSettings(); + AccountRoleSettingsPatch newSettings = gson.fromJson(gson.toJson(settings), AccountRoleSettingsPatch.class); + newSettings.signingUiVersion(signingUiVersion); + PermissionProfile profile = new PermissionProfile() + .permissionProfileName(permissionProfileName) + .settings(newSettings); + //ds-snippet-end:eSign24Step3 + + // Step 4. Call the eSignature REST API + //ds-snippet-start:eSign24Step4 + return accountsApi.createPermissionProfile(accountId, profile); + //ds-snippet-end:eSign24Step4 + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/PermissionDeleteService.java b/src/main/java/com/docusign/controller/eSignature/services/PermissionDeleteService.java new file mode 100644 index 00000000..0436faaf --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/PermissionDeleteService.java @@ -0,0 +1,15 @@ +package com.docusign.controller.eSignature.services; + + +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiException; + +public final class PermissionDeleteService { + public static void permissionDelete( + AccountsApi accountsApi, + String accountId, + String curProfileId + ) throws ApiException { + accountsApi.deletePermissionProfile(accountId, curProfileId); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/PermissionSetUserGroupsService.java b/src/main/java/com/docusign/controller/eSignature/services/PermissionSetUserGroupsService.java new file mode 100644 index 00000000..1ab37589 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/PermissionSetUserGroupsService.java @@ -0,0 +1,28 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.esign.api.GroupsApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.Group; +import com.docusign.esign.model.GroupInformation; + +import java.util.List; + +public final class PermissionSetUserGroupsService { + public static GroupInformation permissionSetUserGroups( + ApiClient apiClient, + String groupId, + String profileId, + String accountId + ) throws ApiException { + GroupsApi groupsApi = new GroupsApi(apiClient); + + // Step 3: Perform request + Group newGroup = new Group() + .groupId(groupId) + .permissionProfileId(profileId); + GroupInformation groupInformation = new GroupInformation() + .groups(List.of(newGroup)); + return groupsApi.updateGroups(accountId, groupInformation); + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/PhoneAuthenticationService.java b/src/main/java/com/docusign/controller/eSignature/services/PhoneAuthenticationService.java new file mode 100644 index 00000000..6c1fd035 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/PhoneAuthenticationService.java @@ -0,0 +1,81 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Arrays; +import java.util.List; + +public final class PhoneAuthenticationService { + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "Lorem"; + + public static EnvelopeSummary phoneAuthentication( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + return envelopesApi.createEnvelope(accountId, envelope); + } + + //ds-snippet-start:eSign20Step4 + public static EnvelopeDefinition createEnvelope(String signerName, String signerEmail, String countryCode, + String phone, String workFlowId) throws IOException { + Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); + + SignHere signHere = new SignHere(); + signHere.setName("SignHereTab"); + signHere.setXPosition("200"); + signHere.setYPosition("160"); + signHere.setTabLabel("SignHereTab"); + signHere.setPageNumber("1"); + signHere.setDocumentId(doc.getDocumentId()); + // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your + // own systems. + // This value is referenced in the Tabs element below to assign tabs on a + // per-recipient basis. + signHere.setRecipientId("1"); + + RecipientIdentityPhoneNumber phoneNumber = new RecipientIdentityPhoneNumber(); + phoneNumber.setCountryCode(countryCode); + phoneNumber.setNumber(phone); + + RecipientIdentityInputOption inputOption = new RecipientIdentityInputOption(); + inputOption.setName("phone_number_list"); + inputOption.setValueType("PhoneNumberList"); + inputOption.setPhoneNumberList(List.of(phoneNumber)); + + RecipientIdentityVerification identityVerifcation = new RecipientIdentityVerification(); + + identityVerifcation.setWorkflowId(workFlowId); + identityVerifcation.setInputOptions(List.of(inputOption)); + + Signer signer = new Signer(); + signer.setName(signerName); + signer.setEmail(signerEmail); + signer.setRoutingOrder("1"); + signer.setStatus(EnvelopeHelpers.SIGNER_STATUS_CREATED); + signer.setDeliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL); + signer.setRecipientId(signHere.getRecipientId()); + signer.setTabs(EnvelopeHelpers.createSignerTabs(signHere)); + signer.setIdentityVerification(identityVerifcation); + + Recipients recipients = new Recipients(); + recipients.setSigners(List.of(signer)); + + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("Please Sign"); + envelope.setDocuments(List.of(doc)); + envelope.setEnvelopeIdStamping("true"); + envelope.setEmailBlurb("Sample text for email body"); + envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + envelope.setRecipients(recipients); + + return envelope; + } + //ds-snippet-end:eSign20Step4 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/ResponsiveSigningService.java b/src/main/java/com/docusign/controller/eSignature/services/ResponsiveSigningService.java new file mode 100644 index 00000000..e6fa9b85 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/ResponsiveSigningService.java @@ -0,0 +1,150 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; + +public final class ResponsiveSigningService { + //ds-snippet-start:eSign38Step2 + private static final String TRUE = "true"; + + private static final String FALSE = "false"; + + private static final int L1_PRICE = 5; + + private static final int L2_PRICE = 150; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + + private static final String DEFAULT_FONT = "helvetica"; + + private static final String DEFAULT_FONT_SIZE = "size11"; + + private static final String ANCHOR_UNITS = "pixels"; + + private static final String HTML_DOCUMENT_FILE_NAME = "templates/order-form.ftl"; + + public static EnvelopeDefinition makeEnvelope( + String signerEmail, + String signerName, + String signerClientId, + String ccEmail, + String ccName, + WorkArguments args + ) throws IOException { + String htmlDoc = EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args); + htmlDoc = htmlDoc + .replace("/l1q/", " ") + .replace("/l2q/", " ");; + + Signer signer = new Signer() + .email(signerEmail) + .name(signerName) + .clientUserId(signerClientId) + .recipientId("1") + .routingOrder("1") + .roleName("Signer"); + + CarbonCopy cc = new CarbonCopy() + .email(ccEmail) + .name(ccName) + .recipientId("2") + .routingOrder("1"); + + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("Example Signing Document"); + envelope.setDocuments(Collections.singletonList( + new Document() + .name("Lorem Ipsum") + .documentId("1") + .htmlDefinition(new DocumentHtmlDefinition().source(htmlDoc)))); + signer.setTabs(createTabs()); + envelope.setRecipients(EnvelopeHelpers.createRecipients(signer, cc)); + envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + return envelope; + } + + private static Tabs createTabs() { + FormulaTab formulaForFirstNumber = createFormulaTab("/l1e/", "l1e", L1_PRICE, "l1q"); + FormulaTab formulaForSecondNumber = createFormulaTab("/l2e/", "l2e", L2_PRICE, "l2q"); + FormulaTab finalFormula = new FormulaTab() + .font(DEFAULT_FONT) + .bold(TRUE) + .fontSize(DEFAULT_FONT_SIZE) + .anchorString("/l3t/") + .anchorYOffset("-8") + .anchorUnits(ANCHOR_UNITS) + .anchorXOffset("105") + .tabLabel("l3t") + .formula("[l1e] + [l2e]") + .roundDecimalPlaces("0") + .required(TRUE) + .locked(TRUE) + .disableAutoSize(FALSE); + + Tabs signerTabs = EnvelopeHelpers.createSingleSignerTab("/sn1/", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X); + signerTabs.formulaTabs(Arrays.asList(formulaForFirstNumber, formulaForSecondNumber, finalFormula)); + + return signerTabs; + } + + private static FormulaTab createFormulaTab(String anchor, String label, int price, String numerical) { + return new FormulaTab() + .font(DEFAULT_FONT) + .fontSize(DEFAULT_FONT_SIZE) + .anchorString(anchor) + .anchorYOffset("-8") + .anchorUnits(ANCHOR_UNITS) + .anchorXOffset("105") + .tabLabel(label) + .formula(String.format("[%s] * {%d}", numerical, price)) + .roundDecimalPlaces("0") + .required(TRUE) + .locked(TRUE) + .disableAutoSize(FALSE); + } + + public static ViewUrl responsiveSigning( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId, + RecipientViewRequest viewRequest + ) throws ApiException { + return envelopesApi.createRecipientView(accountId, envelopeId, viewRequest); + } + + public static RecipientViewRequest makeRecipientViewRequest( + String signerEmail, + String signerName, + DSConfiguration config, + String clientUserId + ) { + RecipientViewRequest viewRequest = new RecipientViewRequest(); + String stateValue = "?state=123"; + viewRequest.setReturnUrl(config.getDsReturnUrl() + stateValue); + + String authenticationMethod = "none"; + viewRequest.setAuthenticationMethod(authenticationMethod); + + viewRequest.setEmail(signerEmail); + viewRequest.setUserName(signerName); + viewRequest.setClientUserId(clientUserId); + + String pingFrequency = "600"; + viewRequest.setPingFrequency(pingFrequency); + viewRequest.setPingUrl(config.getDsPingUrl()); + + return viewRequest; + } + //ds-snippet-end:eSign38Step2 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/SMSDeliveryService.java b/src/main/java/com/docusign/controller/eSignature/services/SMSDeliveryService.java new file mode 100644 index 00000000..53cfb242 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/SMSDeliveryService.java @@ -0,0 +1,103 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Arrays; + +public final class SMSDeliveryService { + private static final String PDF_DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String PDF_DOCUMENT_NAME = "Lorem Ipsum"; + + private static final String DOCX_DOCUMENT_FILE_NAME = "World_Wide_Corp_Battle_Plan_Trafalgar.docx"; + + private static final String DOCX_DOCUMENT_NAME = "Battle Plan"; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + + //ds-snippet-start:eSign37Step3 + public static EnvelopeSummary smsDelivery( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + return envelopesApi.createEnvelope(accountId, envelope); + } + //ds-snippet-end:eSign37Step3 + + //ds-snippet-start:eSign37Step2 + // document 2 (docx) has tag /sn1/ + // document 3 (pdf) has tag /sn1/ + // + // The envelope has two recipients. + // recipient 1 - signer + // recipient 2 - cc + // The envelope will be sent first to the signer. After it is signed, + // a copy is sent to the cc person. + public static EnvelopeDefinition makeEnvelope( + String countryCode, + String signersPhoneNumber, + String signerName, + String deliveryMethod, + String ccCountryCode, + String carbonCopyPhoneNumber, + String ccName, + String status) throws IOException { + // The DocuSign platform searches throughout your envelope's documents + // for matching anchor strings. So the signHere2 tab will be used in + // both document 2 and 3 since they use the same anchor string for + // their "signer 1" tabs. + Tabs signerTabs = EnvelopeHelpers.createSignerTabs( + EnvelopeHelpers.createSignHere("/sn1/", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X)); + + // Create a signer recipient to sign the document, identified by name + // and phone number. We're setting the parameters via the object creation. + // 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. + + RecipientPhoneNumber phoneNumber = new RecipientPhoneNumber(); + phoneNumber.setCountryCode(countryCode); + phoneNumber.setNumber(signersPhoneNumber); + + Signer signer = new Signer(); + signer.setName(signerName); + signer.setPhoneNumber(phoneNumber); + signer.setRecipientId("1"); + signer.setRoutingOrder("1"); + signer.setTabs(signerTabs); + signer.setDeliveryMethod(deliveryMethod); + + // create a cc recipient to receive a copy of the documents, identified by name and phone number + RecipientPhoneNumber ccPhoneNumber = new RecipientPhoneNumber(); + ccPhoneNumber.setCountryCode(ccCountryCode); + ccPhoneNumber.setNumber(carbonCopyPhoneNumber); + + CarbonCopy cc = new CarbonCopy(); + cc.setName(ccName); + cc.setPhoneNumber(ccPhoneNumber); + cc.setRecipientId("2"); + cc.setRoutingOrder("2"); + cc.setDeliveryMethod(deliveryMethod); + + // The order in the docs array determines the order in the envelope + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("Please sign this document set"); + envelope.setDocuments(Arrays.asList( + EnvelopeHelpers.createDocumentFromFile(DOCX_DOCUMENT_FILE_NAME, DOCX_DOCUMENT_NAME, "2"), + EnvelopeHelpers.createDocumentFromFile(PDF_DOCUMENT_FILE_NAME, PDF_DOCUMENT_NAME, "3"))); + envelope.setRecipients(EnvelopeHelpers.createRecipients(signer, cc)); + // Request that the envelope be sent by setting |status| to "sent". + // To request that the envelope be created as a draft, set to "created" + envelope.setStatus(status); + + return envelope; + //ds-snippet-end:eSign37Step2 + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/ScheduledSendlingService.java b/src/main/java/com/docusign/controller/eSignature/services/ScheduledSendlingService.java new file mode 100644 index 00000000..473673ce --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/ScheduledSendlingService.java @@ -0,0 +1,78 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Arrays; +import java.util.List; + +public class ScheduledSendlingService { + private static final String PDF_DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String PDF_DOCUMENT_NAME = "Lorem Ipsum"; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + // document 1 (PDF) has sign here anchor tag /sn1/ + // + // The envelope has one recipient. + // recipient 1 - signer + + // create the envelope definition + + public static EnvelopeDefinition makeEnvelope( + String signerEmail, + String signerName, + String resumeDate, + String status) throws IOException { + // The DocuSign platform searches throughout your envelope's documents + // for matching anchor strings. + + // Step 2 start + //ds-snippet-start:eSign35Step2 + Tabs signerTabs = EnvelopeHelpers.createSignerTabs( + EnvelopeHelpers.createSignHere("/sn1/", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X)); + + // Create a signer recipient to sign the document, identified by name + // and email. We're setting the parameters via the object creation. + // 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. + Signer signer = new Signer(); + signer.setEmail(signerEmail); + signer.setName(signerName); + signer.setRecipientId("1"); + signer.setRoutingOrder("1"); + signer.setTabs(signerTabs); + + // The order in the docs array determines the order in the envelope + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("Please sign this document"); + envelope.setDocuments(List.of( + EnvelopeHelpers.createDocumentFromFile(PDF_DOCUMENT_FILE_NAME, PDF_DOCUMENT_NAME, "1"))); + envelope.setRecipients(EnvelopeHelpers.createSingleRecipient(signer)); + + // Add the workflow to schedule the envelope with a delay + EnvelopeDelayRule delayRule = new EnvelopeDelayRule(); + + delayRule.setResumeDate(resumeDate + "T00:00:00Z"); + + ScheduledSending scheduledSending = new ScheduledSending(); + scheduledSending.setRules(List.of(delayRule)); + + Workflow workflow = new Workflow(); + workflow.setScheduledSending(scheduledSending); + envelope.setWorkflow(workflow); + + // Request that the envelope be sent by setting |status| to "sent". + // To request that the envelope be created as a draft, set to "created" + envelope.setStatus(status); + + return envelope; + //ds-snippet-end:eSign35Step2 + + // Step 2 end + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG010ControllerSendBinaryDocs.java b/src/main/java/com/docusign/controller/eSignature/services/SendBinaryDocsService.java similarity index 67% rename from src/main/java/com/docusign/controller/examples/EG010ControllerSendBinaryDocs.java rename to src/main/java/com/docusign/controller/eSignature/services/SendBinaryDocsService.java index c25df617..0ff64f36 100644 --- a/src/main/java/com/docusign/controller/examples/EG010ControllerSendBinaryDocs.java +++ b/src/main/java/com/docusign/controller/eSignature/services/SendBinaryDocsService.java @@ -1,29 +1,22 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.services; -import com.docusign.DSConfiguration; -import com.docusign.common.DocumentType; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.controller.eSignature.examples.ExampleException; +import com.docusign.core.common.DocumentType; +import com.docusign.core.model.DoneExample; import com.docusign.esign.model.CarbonCopy; import com.docusign.esign.model.Signer; import com.docusign.esign.model.Tabs; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - +import jakarta.ws.rs.HttpMethod; +import jakarta.ws.rs.core.MediaType; import lombok.Value; - import org.json.JSONArray; import org.json.JSONObject; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpHeaders; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; import org.springframework.util.StreamUtils; -import org.springframework.web.bind.annotation.RequestMapping; -import javax.net.ssl.HttpsURLConnection; -import javax.servlet.http.HttpServletResponse; -import javax.ws.rs.HttpMethod; -import javax.ws.rs.core.MediaType; +import javax.net.ssl.HttpsURLConnection; import java.io.DataOutputStream; import java.io.IOException; import java.net.HttpURLConnection; @@ -31,79 +24,84 @@ import java.nio.charset.StandardCharsets; import java.util.List; +public final class SendBinaryDocsService { + private static final int ANCHOR_OFFSET_Y = 10; -/** - * Send an envelope using binary document transfer.
- * The envelope includes a pdf, doc, and HTML document. Multipart data transfer - * is used to send the documents in binary format to DocuSign. - */ -@Controller -@RequestMapping("/eg010") -public class EG010ControllerSendBinaryDocs extends AbstractController { + private static final int ANCHOR_OFFSET_X = 20; private static final String HYPHENS = "--"; + private static final String LINE_DELIMITER = "\r\n"; + private static final String BOUNDARY_DELIMITER = "multipartboundary_multipartboundary"; private static final String HTML_DOCUMENT_FILE_NAME = "templates/candy-bonbon.ftl"; + private static final String HTML_DOCUMENT_NAME = "Order acknowledgement"; + private static final String PDF_DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; - private static final String PDF_DOCUMENT_NAME = "Lorem Ipsum"; - private static final String DOCX_DOCUMENT_FILE_NAME = "World_Wide_Corp_Battle_Plan_Trafalgar.docx"; - private static final String DOCX_DOCUMENT_NAME = "Battle Plan"; - private static final int ANCHOR_OFFSET_Y = 10; - private static final int ANCHOR_OFFSET_X = 20; - private final Session session; - private final User user; + private static final String PDF_DOCUMENT_NAME = "Lorem Ipsum"; + private static final String DOCX_DOCUMENT_FILE_NAME = "World_Wide_Corp_Battle_Plan_Trafalgar.docx"; - @Autowired - public EG010ControllerSendBinaryDocs(DSConfiguration config, Session session, User user) { - super(config, "eg010", "Send envelope with multipart mime"); - this.session = session; - this.user = user; - } + private static final String DOCX_DOCUMENT_NAME = "Battle Plan"; - @Override - // ***DS.snippet.0.start - protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws IOException { - // Step 1. Gather documents and their headers + public static String sendBinaryDocs( + WorkArguments args, + String signerName, + String signerEmail, + String ccName, + String ccEmail, + String basePath, + String accountId, + String accessToken + ) throws IOException { List documents = List.of( new DocumentInfo(HTML_DOCUMENT_NAME, "1", DocumentType.HTML, - EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args)), + EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args) + .getBytes(StandardCharsets.UTF_8)), new DocumentInfo(DOCX_DOCUMENT_NAME, "2", DocumentType.DOCX, EnvelopeHelpers.readFile(DOCX_DOCUMENT_FILE_NAME)), new DocumentInfo(PDF_DOCUMENT_NAME, "3", DocumentType.PDF, EnvelopeHelpers.readFile(PDF_DOCUMENT_FILE_NAME)) - ); - - // Step 2. Make the envelope JSON request body - JSONObject envelopeJSON = makeEnvelopeJSON(args, documents); - - // Step 3. Create the multipart body - URL uri = new URL(String.format("%s/v2.1/accounts/%s/envelopes", session.getBasePath(), session.getAccountId())); - String contentType = String.join("",MediaType.MULTIPART_FORM_DATA, "; boundary=", BOUNDARY_DELIMITER); + ); + + // Make the envelope JSON request body + JSONObject envelopeJSON = SendBinaryDocsService.makeEnvelopeJSON( + signerName, + signerEmail, + ccName, + ccEmail, + documents); + + // Create the multipart body + URL uri = new URL(String.format("%s/v2.1/accounts/%s/envelopes", basePath, accountId)); + String contentType = String.join( + "", + MediaType.MULTIPART_FORM_DATA, + "; boundary=", BOUNDARY_DELIMITER); HttpsURLConnection connection = (HttpsURLConnection) uri.openConnection(); connection.setRequestMethod(HttpMethod.POST); connection.setRequestProperty(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON); connection.setRequestProperty(HttpHeaders.CONTENT_TYPE, contentType); - connection.setRequestProperty(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + user.getAccessToken()); + connection.setRequestProperty(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken); connection.setDoOutput(true); // See https://developers.docusign.com/esign-rest-api/guides/requests-and-responses + //ds-snippet-start:eSign10Step4 DataOutputStream buffer = new DataOutputStream(connection.getOutputStream()); - writeBoundaryHeader(buffer, MediaType.APPLICATION_JSON, "form-data"); + SendBinaryDocsService.writeBoundaryHeader(buffer, MediaType.APPLICATION_JSON, "form-data"); buffer.writeBytes(envelopeJSON.toString(DoneExample.JSON_INDENT_FACTOR)); for (DocumentInfo docInfo : documents) { String content = String.format("file; filename=\"%s\";documentid=%s", docInfo.getName(), docInfo.getId()); buffer.writeBytes(LINE_DELIMITER); - writeBoundaryHeader(buffer, docInfo.getDocType().getMime(), content); + SendBinaryDocsService.writeBoundaryHeader(buffer, docInfo.getDocType().getMime(), content); buffer.write(docInfo.getData()); } - writeClosingBoundary(buffer); + SendBinaryDocsService.writeClosingBoundary(buffer); int responseCode = connection.getResponseCode(); if (responseCode < HttpURLConnection.HTTP_OK || responseCode >= HttpURLConnection.HTTP_MULT_CHOICE) { @@ -111,19 +109,15 @@ protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse throw new ExampleException(error, null); } - String responseString = StreamUtils.copyToString(connection.getInputStream(), StandardCharsets.UTF_8); - JSONObject obj = new JSONObject(responseString); - String envelopeId = obj.getString("envelopeId"); - session.setEnvelopeId(envelopeId); - - DoneExample.createDefault(title) - .withMessage("The envelope has been created and sent!
Envelope ID " + envelopeId + ".") - .addToModel(model); - return DONE_EXAMPLE_PAGE; + return StreamUtils.copyToString(connection.getInputStream(), StandardCharsets.UTF_8); } + //ds-snippet-end:eSign10Step4 - private static void writeBoundaryHeader(DataOutputStream buffer, - String contentType, String contentDisposition) throws IOException { + private static void writeBoundaryHeader( + DataOutputStream buffer, + String contentType, + String contentDisposition + ) throws IOException { buffer.writeBytes(HYPHENS); buffer.writeBytes(BOUNDARY_DELIMITER); buffer.writeBytes(LINE_DELIMITER); @@ -152,7 +146,14 @@ private static void writeClosingBoundary(DataOutputStream buffer) throws IOExcep // recipient 2 - cc // The envelope will be sent first to the signer. // After it is signed, a copy is sent to the cc person. - private static JSONObject makeEnvelopeJSON(WorkArguments args, List documents) { + //ds-snippet-start:eSign10Step3 + private static JSONObject makeEnvelopeJSON( + String signerName, + String signerEmail, + String ccName, + String ccEmail, + List documents + ) { // The DocuSign platform searches throughout your envelope's documents for // matching anchor strings. So the signHere2 tab will be used in both document // 2 and 3 since they use the same anchor string for their "signer 1" tabs. @@ -165,16 +166,16 @@ private static JSONObject makeEnvelopeJSON(WorkArguments args, List 0) { + userInformation = informationList.getUsers().stream() + .filter(user -> "Active".equals(user.getUserStatus())).findFirst().get(); + } + } catch (ApiException e) { + LOGGER.error(e.getMessage()); + } + + return userInformation; + } + + public NewUsersSummary createAgent( + UsersApi usersApi, + String accountId, + String agentEmail, + String agentName, + String activation + ) throws ApiException { + //ds-snippet-start:eSign43Step3 + UserInformation user = new UserInformation(); + user.email(agentEmail); + user.userName(agentName); + user.activationAccessCode(activation); + + NewUsersDefinition usersDefinition = new NewUsersDefinition(); + usersDefinition.addNewUsersItem(user); + + return usersApi.create(accountId, usersDefinition); + //ds-snippet-end:eSign43Step3 + } + + public void activateAgent( + AccountsApi accountsApi, + String accountId, + String userId, + String createdUserId + ) throws ApiException { + AccountsApi.GetAgentUserAuthorizationsOptions options = accountsApi.new GetAgentUserAuthorizationsOptions(); + options.setPermissions(MANAGE); + UserAuthorizations userAuthorizations = accountsApi.getAgentUserAuthorizations(accountId, createdUserId, options); + + if (userAuthorizations.getAuthorizations() == null || userAuthorizations.getAuthorizations().isEmpty()) { + //ds-snippet-start:eSign43Step4 + AuthorizationUser user = new AuthorizationUser(); + user.userId(createdUserId); + user.accountId(accountId); + + UserAuthorizationCreateRequest userAuthorizationCreateRequest = new UserAuthorizationCreateRequest(); + userAuthorizationCreateRequest.agentUser(user); + userAuthorizationCreateRequest.permission(MANAGE); + + accountsApi.createUserAuthorization(accountId, userId, userAuthorizationCreateRequest); + //ds-snippet-end:eSign43Step4 + } + } + + public EnvelopesInformation getEnvelopeInfo( + EnvelopesApi envelopesApi, + String accountId + ) throws ApiException { + //ds-snippet-start:eSign43Step5 + EnvelopesApi.ListStatusChangesOptions options = envelopesApi.new ListStatusChangesOptions(); + LocalDate date = LocalDate.now().minusDays(FROM_DATE_OFFSET_DAYS); + options.setFromDate(DateUtils.DATE_WITH_SLASH.format(date)); + + return envelopesApi.listStatusChanges(accountId, options); + //ds-snippet-end:eSign43Step5 + } +} diff --git a/src/main/java/com/docusign/controller/examples/EG002ControllerSigningViaEmail.java b/src/main/java/com/docusign/controller/eSignature/services/SigningViaEmailService.java similarity index 54% rename from src/main/java/com/docusign/controller/examples/EG002ControllerSigningViaEmail.java rename to src/main/java/com/docusign/controller/eSignature/services/SigningViaEmailService.java index 16baca91..229d700f 100644 --- a/src/main/java/com/docusign/controller/examples/EG002ControllerSigningViaEmail.java +++ b/src/main/java/com/docusign/controller/eSignature/services/SigningViaEmailService.java @@ -1,78 +1,43 @@ -package com.docusign.controller.examples; +package com.docusign.controller.eSignature.services; -import com.docusign.DSConfiguration; -import com.docusign.common.DocumentType; +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.core.common.DocumentType; import com.docusign.esign.api.EnvelopesApi; import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.CarbonCopy; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.Signer; -import com.docusign.esign.model.Tabs; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; +import com.docusign.esign.model.*; + import java.io.IOException; +import java.nio.charset.StandardCharsets; import java.util.Arrays; -import javax.servlet.http.HttpServletResponse; - - -/** - * Send an envelope with a remote (email) signer and cc recipient.
- * The envelope includes a pdf, Word, and HTML document. Anchor text is used to - * position the signing fields in the documents. - */ -@Controller -@RequestMapping("/eg002") -public class EG002ControllerSigningViaEmail extends AbstractController { +public final class SigningViaEmailService { private static final String HTML_DOCUMENT_FILE_NAME = "templates/candy-bonbon.ftl"; + private static final String HTML_DOCUMENT_NAME = "Order acknowledgement"; + private static final String PDF_DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + private static final String PDF_DOCUMENT_NAME = "Lorem Ipsum"; + private static final String DOCX_DOCUMENT_FILE_NAME = "World_Wide_Corp_Battle_Plan_Trafalgar.docx"; + private static final String DOCX_DOCUMENT_NAME = "Battle Plan"; - private static final int ANCHOR_OFFSET_Y = 10; - private static final int ANCHOR_OFFSET_X = 20; - private final Session session; - private final User user; + private static final int ANCHOR_OFFSET_Y = 10; - @Autowired - public EG002ControllerSigningViaEmail(DSConfiguration config, Session session, User user) { - super(config, "eg002", "Signing request by email"); - this.session = session; - this.user = user; - } + private static final int ANCHOR_OFFSET_X = 20; - @Override - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - // Set status for the makeEnvelope method - if (!EnvelopeHelpers.ENVELOPE_STATUS_CREATED.equalsIgnoreCase(args.getStatus())) { - args.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - } - - EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - - EnvelopeDefinition envelope = makeEnvelope(args); - EnvelopeSummary results = envelopesApi.createEnvelope(session.getAccountId(), envelope); - - // process results - session.setEnvelopeId(results.getEnvelopeId()); - DoneExample.createDefault(title) - .withMessage("The envelope has been created and sent!
Envelope ID " - + results.getEnvelopeId() + ".") - .withJsonObject(results) - .addToModel(model); - return DONE_EXAMPLE_PAGE; + //ds-snippet-start:eSign2Step3 + public static EnvelopeSummary signingViaEmail( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + return envelopesApi.createEnvelope(accountId, envelope); } + //ds-snippet-end:eSign2Step3 // document 1 (html) has tag **signature_1** // document 2 (docx) has tag /sn1/ @@ -83,7 +48,16 @@ protected Object doWork(WorkArguments args, ModelMap model, // recipient 2 - cc // The envelope will be sent first to the signer. After it is signed, // a copy is sent to the cc person. - public static EnvelopeDefinition makeEnvelope(WorkArguments args) throws IOException { + + //ds-snippet-start:eSign2Step2 + public static EnvelopeDefinition makeEnvelope( + String signerEmail, + String signerName, + String ccEmail, + String ccName, + String status, + WorkArguments args + ) throws IOException { // The DocuSign platform searches throughout your envelope's documents // for matching anchor strings. So the signHere2 tab will be used in // both document 2 and 3 since they use the same anchor string for @@ -98,21 +72,22 @@ public static EnvelopeDefinition makeEnvelope(WorkArguments args) throws IOExcep // to the recipients. Parallel routing order is supported by using the // same integer as the order for two or more recipients. Signer signer = new Signer(); - signer.setEmail(args.getSignerEmail()); - signer.setName(args.getSignerName()); + signer.setEmail(signerEmail); + signer.setName(signerName); signer.setRecipientId("1"); signer.setRoutingOrder("1"); signer.setTabs(signerTabs); // create a cc recipient to receive a copy of the documents, identified by name and email CarbonCopy cc = new CarbonCopy(); - cc.setEmail(args.getCcEmail()); - cc.setName(args.getCcName()); + cc.setEmail(ccEmail); + cc.setName(ccName); cc.setRecipientId("2"); cc.setRoutingOrder("2"); // The order in the docs array determines the order in the envelope - byte[] htmlDocument = EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args); + byte[] htmlDocument = EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args) + .getBytes(StandardCharsets.UTF_8); EnvelopeDefinition envelope = new EnvelopeDefinition(); envelope.setEmailSubject("Please sign this document set"); envelope.setDocuments(Arrays.asList( @@ -123,8 +98,9 @@ public static EnvelopeDefinition makeEnvelope(WorkArguments args) throws IOExcep envelope.setRecipients(EnvelopeHelpers.createRecipients(signer, cc)); // Request that the envelope be sent by setting |status| to "sent". // To request that the envelope be created as a draft, set to "created" - envelope.setStatus(args.getStatus()); + envelope.setStatus(status); return envelope; } + //ds-snippet-end:eSign2Step2 } diff --git a/src/main/java/com/docusign/controller/eSignature/services/UnpauseSignatureWorkflowService.java b/src/main/java/com/docusign/controller/eSignature/services/UnpauseSignatureWorkflowService.java new file mode 100644 index 00000000..c68e4b51 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/UnpauseSignatureWorkflowService.java @@ -0,0 +1,38 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.Envelope; +import com.docusign.esign.model.EnvelopeUpdateSummary; +import com.docusign.esign.model.Workflow; + +public class UnpauseSignatureWorkflowService { + public static EnvelopeUpdateSummary unpauseSignatureWorkflow( + EnvelopesApi envelopesApi, + String accountId, + String envelopeId + ) throws ApiException { + // Step 3: Construct your envelope JSON body + //ds-snippet-start:eSign33Step3 + Workflow workflow = new Workflow(); + workflow.setWorkflowStatus(EnvelopeHelpers.WORKFLOW_STATUS_IN_PROGRESS); + + Envelope envelope = new Envelope(); + envelope.setWorkflow(workflow); + + EnvelopesApi.UpdateOptions updateOptions = envelopesApi.new UpdateOptions(); + updateOptions.setResendEnvelope("true"); + //ds-snippet-end:eSign33Step3 + + // Step 4: Call the eSignature REST API + //ds-snippet-start:eSign33Step4 + return envelopesApi.update( + accountId, + envelopeId, + envelope, + updateOptions + ); + //ds-snippet-end:eSign33Step4 + } +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/UseConditionalRecipientsService.java b/src/main/java/com/docusign/controller/eSignature/services/UseConditionalRecipientsService.java new file mode 100644 index 00000000..7f511624 --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/UseConditionalRecipientsService.java @@ -0,0 +1,223 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; + +public class UseConditionalRecipientsService { + private static final String DOCUMENT_FILE_NAME = "Welcome1.txt"; + + private static final String DOCUMENT_ID = "1"; + + private static final String DOCUMENT_NAME = "Welcome"; + + //ds-snippet-start:eSign34Step4 + public static EnvelopeSummary useConditionalRecipients( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + return envelopesApi.createEnvelope(accountId, envelope); + } + //ds-snippet-end:eSign34Step4 + + //ds-snippet-start:eSign34Step3 + public static EnvelopeDefinition createEnvelope( + String signerNotCheckedName, + String signerNotCheckedEmail, + String signerCheckedName, + String signerCheckedEmail, + String signerName, + String signerEmail + ) throws IOException { + Document document = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, DOCUMENT_ID); + + WorkflowStep workflowStep = new WorkflowStep(); + workflowStep.setAction(EnvelopeHelpers.WORKFLOW_STEP_ACTION_PAUSE); + workflowStep.setTriggerOnItem(EnvelopeHelpers.WORKFLOW_TRIGGER_ROUTING_ORDER); + workflowStep.setItemId("2"); + workflowStep.setStatus("pending"); + workflowStep.setRecipientRouting(createRecipientRouting( + signerNotCheckedName, + signerNotCheckedEmail, + signerCheckedName, + signerCheckedEmail + )); + + Workflow workflow = new Workflow(); + workflow.setWorkflowSteps(Collections.singletonList(workflowStep)); + + Recipients recipients = new Recipients(); + recipients.setSigners(Arrays.asList( + createApprovalSigner(document.getDocumentId()), + createPurchaserSigner(signerName, signerEmail, document.getDocumentId()) + )); + + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setEmailSubject("ApproveIfChecked"); + envelope.setDocuments(Collections.singletonList(document)); + envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + envelope.setRecipients(recipients); + envelope.setWorkflow(workflow); + + return envelope; + } + + private static Signer createPurchaserSigner( + String signerName, + String signerEmail, + String documentId + ) { + SignHere signHere = new SignHere(); + signHere.setName("SignHereTabs"); + signHere.setXPosition("200"); + signHere.setYPosition("200"); + signHere.setTabLabel("PurchaserSignature"); + signHere.setPageNumber("1"); + signHere.setDocumentId(documentId); + + Checkbox checkbox = new Checkbox(); + checkbox.setName("ClickToApprove"); + checkbox.setSelected("false"); + checkbox.setXPosition("50"); + checkbox.setYPosition("50"); + checkbox.setTabLabel("ApproveWhenChecked"); + checkbox.setPageNumber("1"); + checkbox.setDocumentId(documentId); + + Tabs tabs = EnvelopeHelpers.createSignerTabs(signHere); + tabs.setCheckboxTabs(Collections.singletonList(checkbox)); + + Signer signer = new Signer(); + signer.setName(signerName); + signer.setEmail(signerEmail); + signer.setRoutingOrder("1"); + signer.setRecipientId("1"); + signer.setRoleName("Purchaser"); + signer.setTabs(tabs); + + return signer; + } + + private static Signer createApprovalSigner(String documentId) { + SignHere signHere = new SignHere(); + signHere.setName("SignHere"); + signHere.setRecipientId("2"); + signHere.setXPosition("200"); + signHere.setYPosition("300"); + signHere.setTabLabel("ApproverSignature"); + signHere.setPageNumber("1"); + signHere.setDocumentId(documentId); + + Signer signer = new Signer(); + signer.setName("Approver"); + signer.setEmail("placeholder@example.com"); + signer.setRoutingOrder("2"); + signer.setRecipientId("2"); + signer.setRoleName("Approver"); + signer.setTabs(EnvelopeHelpers.createSignerTabs(signHere)); + return signer; + } + + private static List createConditionalRecipientRuleConditions() { + + ConditionalRecipientRuleFilter filter1 = new ConditionalRecipientRuleFilter(); + filter1.setRecipientId("1"); + filter1.setScope("tabs"); + filter1.setTabId("ApprovalTab"); + filter1.setOperator("equals"); + filter1.setValue("false"); + filter1.setTabType("checkbox"); + filter1.setTabLabel("ApproveWhenChecked"); + + ConditionalRecipientRuleFilter filter2 = new ConditionalRecipientRuleFilter(); + filter2.setRecipientId("1"); + filter2.setScope("tabs"); + filter2.setTabId("ApprovalTab"); + filter2.setOperator("equals"); + filter2.setValue("true"); + filter2.setTabType("checkbox"); + filter2.setTabLabel("ApproveWhenChecked"); + + ConditionalRecipientRuleCondition condition1 = new ConditionalRecipientRuleCondition(); + condition1.setRecipientLabel("signer2a"); + condition1.setOrder("1"); + condition1.setFilters(Collections.singletonList(filter1)); + + ConditionalRecipientRuleCondition condition2 = new ConditionalRecipientRuleCondition(); + condition2.setRecipientLabel("signer2b"); + condition2.setOrder("2"); + condition2.setFilters(Collections.singletonList(filter2)); + return Arrays.asList(condition1, condition2); + } + + private static RecipientGroup createRecipientGroup( + String signerNotCheckedName, + String signerNotCheckedEmail, + String signerCheckedName, + String signerCheckedEmail + ) { + RecipientOption recipientOption1 = new RecipientOption(); + recipientOption1.setRecipientLabel("signer2a"); + recipientOption1.setName(signerNotCheckedName); + recipientOption1.setRoleName("Signer when not checked"); + recipientOption1.setEmail(signerNotCheckedEmail); + + RecipientOption recipientOption2 = new RecipientOption(); + recipientOption2.setRecipientLabel("signer2b"); + recipientOption2.setName(signerCheckedName); + recipientOption2.setRoleName("Signer when checked"); + recipientOption2.setEmail(signerCheckedEmail); + + RecipientGroup recipientGroup = new RecipientGroup(); + recipientGroup.setGroupName("Approver"); + recipientGroup.setGroupMessage("Members of this group approve a workflow"); + recipientGroup.setRecipients(Arrays.asList(recipientOption1, recipientOption2)); + return recipientGroup; + } + + private static ConditionalRecipientRule createConditionalRecipientRule( + String signerNotCheckedName, + String signerNotCheckedEmail, + String signerCheckedName, + String signerCheckedEmail + ) { + ConditionalRecipientRule conditionalRecipientRule = new ConditionalRecipientRule(); + conditionalRecipientRule.setRecipientId("2"); + conditionalRecipientRule.setOrder("0"); + conditionalRecipientRule.setRecipientGroup(createRecipientGroup( + signerNotCheckedName, + signerNotCheckedEmail, + signerCheckedName, + signerCheckedEmail + )); + conditionalRecipientRule.setConditions(createConditionalRecipientRuleConditions()); + return conditionalRecipientRule; + } + + private static RecipientRouting createRecipientRouting( + String signerNotCheckedName, + String signerNotCheckedEmail, + String signerCheckedName, + String signerCheckedEmail + ) { + RecipientRules recipientRules = new RecipientRules(); + recipientRules.setConditionalRecipients(Collections.singletonList(createConditionalRecipientRule( + signerNotCheckedName, + signerNotCheckedEmail, + signerCheckedName, + signerCheckedEmail + ))); + + RecipientRouting recipientRouting = new RecipientRouting(); + recipientRouting.setRules(recipientRules); + return recipientRouting; + } + //ds-snippet-end:eSign34Step3 +} diff --git a/src/main/java/com/docusign/controller/eSignature/services/UseTemplateService.java b/src/main/java/com/docusign/controller/eSignature/services/UseTemplateService.java new file mode 100644 index 00000000..ee06384d --- /dev/null +++ b/src/main/java/com/docusign/controller/eSignature/services/UseTemplateService.java @@ -0,0 +1,60 @@ +package com.docusign.controller.eSignature.services; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.api.TemplatesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.EnvelopeTemplateResults; +import com.docusign.esign.model.TemplateRole; + +import java.util.Arrays; + +public final class UseTemplateService { + //ds-snippet-start:eSign9Step3 + public static EnvelopeSummary createEnvelopeTemplate( + EnvelopesApi envelopesApi, + String accountId, + EnvelopeDefinition envelope + ) throws ApiException { + return envelopesApi.createEnvelope(accountId, envelope); + } + //ds-snippet-end:eSign9Step3 + + public static EnvelopeTemplateResults listTemplates( + ApiClient apiClient, + String accountId + ) throws ApiException { + TemplatesApi templatesApi = new TemplatesApi(apiClient); + return templatesApi.listTemplates(accountId); + } + + //ds-snippet-start:eSign9Step2 + public static EnvelopeDefinition makeEnvelope( + String signerName, + String signerEmail, + String ccEmail, + String ccName, + String templateId + ) { + TemplateRole signer = new TemplateRole(); + signer.setEmail(signerEmail); + signer.setName(signerName); + signer.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + + TemplateRole cc = new TemplateRole(); + cc.setEmail(ccEmail); + cc.setName(ccName); + cc.setRoleName(EnvelopeHelpers.CC_ROLE_NAME); + + EnvelopeDefinition envelope = new EnvelopeDefinition(); + envelope.setTemplateId(templateId); + envelope.setTemplateRoles(Arrays.asList(signer, cc)); + envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + return envelope; + } + //ds-snippet-end:eSign9Step2 +} diff --git a/src/main/java/com/docusign/controller/examples/AbstractController.java b/src/main/java/com/docusign/controller/examples/AbstractController.java deleted file mode 100644 index 9f8f4494..00000000 --- a/src/main/java/com/docusign/controller/examples/AbstractController.java +++ /dev/null @@ -1,178 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.AccountsApi; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiClient; -import com.docusign.esign.client.ApiException; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.http.HttpHeaders; -import org.springframework.security.oauth2.client.OAuth2ClientContext; -import org.springframework.security.oauth2.common.OAuth2AccessToken; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PostMapping; - -import java.io.IOException; -import java.util.Objects; -import javax.servlet.http.HttpServletResponse; - - -/** - * Abstract base class for all controllers. It handles all requests which are - * registered by the derived classes and delegates an example specific action - * back to the appropriate controllers. If a user had not been authorized, it - * redirects him onto an authentication page. Derived classes must override an - * abstract method {@link #doWork(WorkArguments, ModelMap, HttpServletResponse)} - * to do something. This method is called from the POST request. Optionally you - * can override method {@link #onInitModel(WorkArguments, ModelMap)} to add - * example specific attributes into a page. - */ -@Controller -public abstract class AbstractController { - - protected static final String MODEL_ENVELOPE_OK = "envelopeOk"; - private static final String REDIRECT_PREFIX = "redirect:"; - private static final String REDIRECT_AUTHENTICATION_PAGE = REDIRECT_PREFIX + "/ds/mustAuthenticate"; - private static final String EXAMPLE_PAGES_PATH = "pages/examples/"; - protected static final String BEARER_AUTHENTICATION = "Bearer "; - protected static final String DONE_EXAMPLE_PAGE = "pages/example_done"; - protected static final String DONE_EXAMPLE_PAGE_COMPARE = "pages/example_done_compare"; - protected static final String ERROR_PAGE = "error.jsp"; - - @Autowired - private OAuth2ClientContext oAuth2ClientContext; - - @Autowired - private Session session; - - protected final String exampleName; - protected final String title; - private final String pagePath; - protected final DSConfiguration config; - - public AbstractController(DSConfiguration config, String exampleName, String title) { - this.config = config; - this.exampleName = exampleName; - pagePath = EXAMPLE_PAGES_PATH + exampleName; - this.title = title; - } - - @GetMapping - public String get(WorkArguments args, ModelMap model) { - if (isTokenExpired()) { - return REDIRECT_AUTHENTICATION_PAGE; - } - - try { - onInitModel(args, model); - return pagePath; - } catch (ApiException exception) { - return handleException(exception, model); - } - } - - @PostMapping - public Object create(WorkArguments args, ModelMap model, HttpServletResponse response) { - if (isTokenExpired()) { - return REDIRECT_AUTHENTICATION_PAGE; - } - - try { - return doWork(args, model, response); - } catch (IOException|ApiException exception) { - return handleException(exception, model); - } - } - - /** - * This method is called from the GET request and it should initialize a - * model. Override this method if it is necessary to add example specific - * attributes into the model. - * @param args the session attributes - * @param model the model data - * @throws ApiException if calling eSign API has failed - */ - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { - Class clazz = Objects.requireNonNullElse(getClass().getEnclosingClass(), getClass()); - String srcPath = String.join("", config.getExampleUrl(), clazz.getName().replace('.', '/'), ".java"); - model.addAttribute("csrfToken", ""); - model.addAttribute("title", title); - model.addAttribute("sourceFile", clazz.getSimpleName() + ".java"); - model.addAttribute("sourceUrl", srcPath); - model.addAttribute("documentation", config.getDocumentationPath() + exampleName); - } - - /** - * This method is called from the POST request. Example pages must override - * it. Overridden method should return an Object means URL to redirect. - * @param args the work arguments got from the current page - * @param model page model holder - * @param response for HTTP-specific functionality in sending a response - * @return {@link Object}. Possible types and values: null, - * {@link String} representation of the URL or Spring RedirectView object, - * (see {@link org.springframework.web.servlet.view.RedirectView RedirectView}) - * @throws ApiException if calling eSignature API has failed - * @throws IOException if I/O operation has failed - */ - protected abstract Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException; - - /** - * Creates new instance of the eSignature API client. - * @param basePath URL to eSignature REST API - * @param userAccessToken user's access token - * @return an instance of the {@link ApiClient} - */ - protected static ApiClient createApiClient(String basePath, String userAccessToken) { - ApiClient apiClient = new ApiClient(basePath); - apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + userAccessToken); - // it is a workaround to NPE, see DSPW-61 - apiClient.addAuthorization("docusignAccessCode", null); - return apiClient; - } - - /** - * Creates a new instance of the eSignature EnvelopesApi. This method - * creates an instance of the ApiClient class silently. - * @param basePath URL to eSignature REST API - * @param userAccessToken user's access token - * @return an instance of the {@link EnvelopesApi} - */ - protected static EnvelopesApi createEnvelopesApi(String basePath, String userAccessToken) { - ApiClient apiClient = createApiClient(basePath, userAccessToken); - return new EnvelopesApi(apiClient); - } - - /** - * Creates a new instance of the eSignature AccountsApi. This method - * creates an instance of the ApiClient class silently. - * @param basePath URL to eSignature REST API - * @param userAccessToken user's access token - * @return an instance of the {@link AccountsApi} - */ - protected static AccountsApi createAccountsApi(String basePath, String userAccessToken) { - ApiClient apiClient = createApiClient(basePath, userAccessToken); - return new AccountsApi(apiClient); - } - - private String handleException(Exception exception, ModelMap model) { - new DoneExample() - .withTitle(exampleName) - .withName(title) - .withMessage(exception.getMessage()) - .withStackTrace(exception.getStackTrace()) - .addToModel(model); - return ERROR_PAGE; - } - - private boolean isTokenExpired() { - OAuth2AccessToken accessToken = oAuth2ClientContext.getAccessToken(); - boolean tokenExpired = accessToken != null && accessToken.isExpired(); - session.setRefreshToken(tokenExpired); - return tokenExpired; - } -} diff --git a/src/main/java/com/docusign/controller/examples/EG001ControllerEmbeddedSigning.java b/src/main/java/com/docusign/controller/examples/EG001ControllerEmbeddedSigning.java deleted file mode 100644 index 9534f183..00000000 --- a/src/main/java/com/docusign/controller/examples/EG001ControllerEmbeddedSigning.java +++ /dev/null @@ -1,144 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiClient; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.RecipientViewRequest; -import com.docusign.esign.model.Recipients; -import com.docusign.esign.model.Signer; -import com.docusign.esign.model.ViewUrl; -import com.docusign.model.Session; -import com.docusign.model.User; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.servlet.view.RedirectView; - -import java.io.IOException; -import java.util.Arrays; - -import javax.servlet.http.HttpServletResponse; - - -/** - * Embedded Signing Ceremony.
- * This example sends an envelope, and then uses an embedded signing ceremony - * for the first signer. Embedded signing provides a smoother user experience - * for the signer: the DocuSign signing ceremony is initiated from your site. - */ -@Controller -@RequestMapping("/eg001") -public class EG001ControllerEmbeddedSigning extends AbstractController { - - private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; - private static final String DOCUMENT_NAME = "Lorem Ipsum"; - private static final int ANCHOR_OFFSET_Y = 20; - private static final int ANCHOR_OFFSET_X = 10; - private static final String SIGNER_CLIENT_ID = "1000"; - - private final Session session; - private final User user; - - - @Autowired - public EG001ControllerEmbeddedSigning(DSConfiguration config, Session session, User user) { - super(config, "eg001", "Embedded Signing Ceremony"); - this.session = session; - this.user = user; - } - - @Override - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - String signerName = args.getSignerName(); - String signerEmail = args.getSignerEmail(); - String accountId = session.getAccountId(); - - // Step 1. Create the envelope definition - EnvelopeDefinition envelope = makeEnvelope(signerEmail, signerName); - - // Step 2. Call DocuSign to create the envelope - ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); - EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); - EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); - - String envelopeId = envelopeSummary.getEnvelopeId(); - session.setEnvelopeId(envelopeId); - - // Step 3. create the recipient view, the Signing Ceremony - RecipientViewRequest viewRequest = makeRecipientViewRequest(signerEmail, signerName); - ViewUrl viewUrl = envelopesApi.createRecipientView(accountId, envelopeId, viewRequest); - - // Step 4. Redirect the user to the Signing Ceremony - // Don't use an iFrame! - // State can be stored/recovered using the framework's session or a - // query parameter on the returnUrl (see the makeRecipientViewRequest method) - return new RedirectView(viewUrl.getUrl()); - } - - private RecipientViewRequest makeRecipientViewRequest(String signerEmail, String signerName) { - RecipientViewRequest viewRequest = new RecipientViewRequest(); - // Set the url where you want the recipient to go once they are done signing - // should typically be a callback route somewhere in your app. - // The query parameter is included as an example of how - // to save/recover state information during the redirect to - // the DocuSign signing ceremony. It's usually better to use - // the session mechanism of your web framework. Query parameters - // can be changed/spoofed very easily. - viewRequest.setReturnUrl(config.getDsReturnUrl() + "?state=123"); - - // How has your app authenticated the user? In addition to your app's - // authentication, you can include authenticate steps from DocuSign. - // Eg, SMS authentication - viewRequest.setAuthenticationMethod("none"); - - // Recipient information must match embedded recipient info - // we used to create the envelope. - viewRequest.setEmail(signerEmail); - viewRequest.setUserName(signerName); - viewRequest.setClientUserId(SIGNER_CLIENT_ID); - - // DocuSign recommends that you redirect to DocuSign for the - // Signing Ceremony. There are multiple ways to save state. - // To maintain your application's session, use the pingUrl - // parameter. It causes the DocuSign Signing Ceremony web page - // (not the DocuSign server) to send pings via AJAX to your app. - // NOTE: The pings will only be sent if the pingUrl is an https address - viewRequest.setPingFrequency("600"); // seconds - viewRequest.setPingUrl(config.getDsPingUrl()); - - return viewRequest; - } - - private static EnvelopeDefinition makeEnvelope(String signerEmail, String signerName) throws IOException { - // Create a signer recipient to sign the document, identified by name and email - // We set the clientUserId to enable embedded signing for the recipient - Signer signer = new Signer(); - signer.setEmail(signerEmail); - signer.setName(signerName); - signer.clientUserId(SIGNER_CLIENT_ID); - signer.recipientId("1"); - signer.setTabs(EnvelopeHelpers.createSingleSignerTab("/sn1/", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X)); - - // Add the recipient to the envelope object - Recipients recipients = new Recipients(); - recipients.setSigners(Arrays.asList(signer)); - - EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); - envelopeDefinition.setEmailSubject("Please sign this document"); - envelopeDefinition.setRecipients(recipients); - Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "3"); - envelopeDefinition.setDocuments(Arrays.asList(doc)); - // Request that the envelope be sent by setting |status| to "sent". - // To request that the envelope be created as a draft, set to "created" - envelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - - return envelopeDefinition; - } -} diff --git a/src/main/java/com/docusign/controller/examples/EG003ControllerListEnvelopes.java b/src/main/java/com/docusign/controller/examples/EG003ControllerListEnvelopes.java deleted file mode 100644 index d363b2ee..00000000 --- a/src/main/java/com/docusign/controller/examples/EG003ControllerListEnvelopes.java +++ /dev/null @@ -1,60 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.api.EnvelopesApi.ListStatusChangesOptions; -import com.docusign.esign.client.ApiException; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -import java.time.LocalDate; -import java.time.format.DateTimeFormatter; - -import javax.servlet.http.HttpServletResponse; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; - - -/** - * List envelopes in the user's account.
- * List the envelopes created in the last 30 days. This example demonstrates - * how to query DocuSign about envelopes sent by the current user. - */ -@Controller -@RequestMapping("/eg003") -public class EG003ControllerListEnvelopes extends AbstractController { - - private static final int FROM_DATE_OFFSET_DAYS = 30; - private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy/MM/dd"); - - private final Session session; - private final User user; - - - @Autowired - public EG003ControllerListEnvelopes(DSConfiguration config, Session session, User user) { - super(config, "eg003", "List envelopes"); - this.session = session; - this.user = user; - } - - @Override - // ***DS.snippet.0.start - protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException { - EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - ListStatusChangesOptions options = envelopesApi.new ListStatusChangesOptions(); - LocalDate date = LocalDate.now().minusDays(FROM_DATE_OFFSET_DAYS); - options.setFromDate(DATE_FORMATTER.format(date)); - - DoneExample.createDefault(title) - .withMessage("Results from the Envelopes::listStatusChanges method:") - .withJsonObject(envelopesApi.listStatusChanges(session.getAccountId(), options)) - .addToModel(model); - return DONE_EXAMPLE_PAGE; - } - // ***DS.snippet.0.end -} diff --git a/src/main/java/com/docusign/controller/examples/EG013ControllerAddDocToTemplate.java b/src/main/java/com/docusign/controller/examples/EG013ControllerAddDocToTemplate.java deleted file mode 100644 index d431219e..00000000 --- a/src/main/java/com/docusign/controller/examples/EG013ControllerAddDocToTemplate.java +++ /dev/null @@ -1,182 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.common.DocumentType; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.api.TemplatesApi; -import com.docusign.esign.client.ApiClient; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.CarbonCopy; -import com.docusign.esign.model.CompositeTemplate; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.EnvelopeTemplateResults; -import com.docusign.esign.model.InlineTemplate; -import com.docusign.esign.model.RecipientViewRequest; -import com.docusign.esign.model.ServerTemplate; -import com.docusign.esign.model.Signer; -import com.docusign.esign.model.Tabs; -import com.docusign.esign.model.ViewUrl; -import com.docusign.model.Session; -import com.docusign.model.User; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.servlet.view.RedirectView; - -import java.io.IOException; -import java.util.Arrays; - -import javax.servlet.http.HttpServletResponse; - - -/** - * Embedded Signing Ceremony from a template with an added document.
- * This example sends an envelope based on a template. In addition to the - * template's document(s), the example adds an additional document to the - * envelope by using the Composite Templates. - */ -@Controller -@RequestMapping("/eg013") -public class EG013ControllerAddDocToTemplate extends AbstractController { - - private static final String MODEL_LIST_TEMPLATE = "listTemplates"; - private static final String SIGNER_CLIENT_ID = "1000"; - private static final String HTML_DOCUMENT_FILE_NAME = "templates/candy-bonbon2.ftl"; - private static final String HTML_DOCUMENT_NAME = "Appendix 1--Sales order"; - private static final int ANCHOR_OFFSET_Y = 10; - private static final int ANCHOR_OFFSET_X = 20; - - private final Session session; - private final User user; - - - @Autowired - public EG013ControllerAddDocToTemplate(DSConfiguration config, Session session, User user) { - super(config, "eg013", "Embedded Signing Ceremony from template and extra doc"); - this.session = session; - this.user = user; - } - - @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { - super.onInitModel(args, model); - ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); - TemplatesApi templatesApi = new TemplatesApi(apiClient); - EnvelopeTemplateResults templates = templatesApi.listTemplates(session.getAccountId()); - model.addAttribute(MODEL_LIST_TEMPLATE, templates.getEnvelopeTemplates()); - } - - @Override - // ***DS.snippet.0.start - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - String accountId = session.getAccountId(); - EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - - // Step 1. Make the envelope request body - args.setDsReturnUrl(config.getDsReturnUrl()); - args.setDsPingUrl(config.getDsPingUrl()); - args.setSignerClientId(SIGNER_CLIENT_ID); - EnvelopeDefinition envelope = makeEnvelope(args); - - // Step 2. call Envelopes::create API method - EnvelopeSummary results = envelopesApi.createEnvelope(accountId, envelope); - - // Step 3. create the recipient view, the Signing Ceremony - RecipientViewRequest viewRequest = makeRecipientViewRequest(args); - ViewUrl viewUrl = envelopesApi.createRecipientView(accountId, results.getEnvelopeId(), viewRequest); - return new RedirectView(viewUrl.getUrl()); - } - - private static RecipientViewRequest makeRecipientViewRequest(WorkArguments args) { - RecipientViewRequest viewRequest = new RecipientViewRequest(); - // Set the url where you want the recipient to go once they are done signing - // should typically be a callback route somewhere in your app. - viewRequest.setReturnUrl(args.getDsReturnUrl()); - // How has your app authenticated the user? In addition to your app's - // authentication, you can include authenticate steps from DocuSign. - // Eg, SMS authentication - viewRequest.setAuthenticationMethod("none"); - // Recipient information must match embedded recipient info - // we used to create the envelope. - viewRequest.setEmail(args.getSignerEmail()); - viewRequest.setUserName(args.getSignerName()); - viewRequest.setClientUserId(args.getSignerClientId()); - - // DocuSign recommends that you redirect to DocuSign for the - // Signing Ceremony. There are multiple ways to save state. - // To maintain your application's session, use the pingUrl - // parameter. It causes the DocuSign Signing Ceremony web page - // (not the DocuSign server) to send pings via AJAX to your app. - // NOTE: The pings will only be sent if the pingUrl is an https address - viewRequest.setPingFrequency("600"); - viewRequest.setPingUrl(args.getDsPingUrl()); - - return viewRequest; - } - - // The envelope request object uses Composite Template to include in the envelope: - // 1. A template stored on the DocuSign service - // 2. An additional document which is a custom HTML source document - private EnvelopeDefinition makeEnvelope(WorkArguments args) throws IOException { - // Create a signer and cc recipients for the signer role of the server template - CarbonCopy cc1 = new CarbonCopy(); - cc1.setEmail(args.getCcEmail()); - cc1.setName(args.getCcName()); - cc1.setRoleName(EnvelopeHelpers.CC_ROLE_NAME); - cc1.setRecipientId("2"); - - // create a composite template for the Server Template - CompositeTemplate compTemplate1 = new CompositeTemplate(); - compTemplate1.setCompositeTemplateId("1"); - ServerTemplate serverTemplates = new ServerTemplate(); - serverTemplates.setSequence("1"); - serverTemplates.setTemplateId(args.getTemplateId()); - compTemplate1.setServerTemplates(Arrays.asList(serverTemplates)); - - // Add the roles via an inlineTemplate - InlineTemplate inlineTemplate = new InlineTemplate(); - inlineTemplate.setSequence("1"); - inlineTemplate.setRecipients(EnvelopeHelpers.createRecipients(createSigner(args), cc1)); - compTemplate1.setInlineTemplates(Arrays.asList(inlineTemplate)); - - // The signer recipient for the added document with a tab definition: - Tabs signer1Tabs = EnvelopeHelpers.createSingleSignerTab("**signature_1**", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X); - Signer signer1AddedDoc = createSigner(args); - signer1AddedDoc.setTabs(signer1Tabs); - - // create the HTML document - byte[] htmlDoc = EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args); - - // create a composite template for the added document and add the recipients via an inlineTemplate - CompositeTemplate compTemplate2 = new CompositeTemplate(); - compTemplate2.setCompositeTemplateId("2"); - InlineTemplate inlineTemplate2 = new InlineTemplate(); - inlineTemplate2.setSequence("2"); - inlineTemplate2.setRecipients(EnvelopeHelpers.createRecipients(signer1AddedDoc, cc1)); - compTemplate2.setInlineTemplates(Arrays.asList(inlineTemplate2)); - compTemplate2.setDocument(EnvelopeHelpers.createDocument(htmlDoc, HTML_DOCUMENT_NAME, - DocumentType.HTML.getDefaultFileExtention(), "1")); - - EnvelopeDefinition env = new EnvelopeDefinition(); - env.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - env.setCompositeTemplates(Arrays.asList(compTemplate1, compTemplate2)); - - return env; - } - - // Adding clientUserId transforms the template recipient into an embedded recipient - private static Signer createSigner(WorkArguments args) { - Signer signer = new Signer(); - signer.setEmail(args.getSignerEmail()); - signer.setName(args.getSignerName()); - signer.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME); - signer.setRecipientId("1"); - signer.setClientUserId(args.getSignerClientId()); - return signer; - } - // ***DS.snippet.0.end -} diff --git a/src/main/java/com/docusign/controller/examples/EG017ControllerSetTemplateTabValues.java b/src/main/java/com/docusign/controller/examples/EG017ControllerSetTemplateTabValues.java deleted file mode 100644 index 8a5ecd6f..00000000 --- a/src/main/java/com/docusign/controller/examples/EG017ControllerSetTemplateTabValues.java +++ /dev/null @@ -1,217 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiClient; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.*; -import com.docusign.esign.model.Checkbox; -import com.docusign.esign.model.List; -import com.docusign.model.Session; -import com.docusign.model.User; -import com.sun.xml.bind.v2.runtime.unmarshaller.XsiNilLoader; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.servlet.view.RedirectView; - -import javax.servlet.http.HttpServletResponse; -import java.awt.*; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Arrays; - - -@Controller -@RequestMapping("/eg017") -public class EG017ControllerSetTemplateTabValues extends AbstractController { - - private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_salary.pdf"; - private static final String DOCUMENT_NAME = "Lorem Ipsum"; - private static final int ANCHOR_OFFSET_Y = 20; - private static final int ANCHOR_OFFSET_X = 10; - private static final String SIGNER_CLIENT_ID = "1000"; - - private final Session session; - private final User user; - - - @Autowired - public EG017ControllerSetTemplateTabValues(DSConfiguration config, Session session, User user) { - super(config, "eg017", "Set template tab values"); - this.session = session; - this.user = user; - } - - @Override - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - String signerName = args.getSignerName(); - String signerEmail = args.getSignerEmail(); - String accountId = session.getAccountId(); - String ccName = args.getCcName(); - String ccEmail = args.getCcEmail(); - String templateId = args.getTemplateId(); - - // Step 1. Create the envelope definition - EnvelopeDefinition envelope = makeEnvelope(signerEmail, signerName, ccName, ccEmail, templateId); - - // Step 2. Call DocuSign to create the envelope - ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); - EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); - EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envelope); - - String envelopeId = envelopeSummary.getEnvelopeId(); - session.setEnvelopeId(envelopeId); - - // Step 3. create the recipient view, the Signing Ceremony - RecipientViewRequest viewRequest = makeRecipientViewRequest(signerEmail, signerName); - ViewUrl viewUrl = envelopesApi.createRecipientView(accountId, envelopeId, viewRequest); - - // Step 4. Redirect the user to the Signing Ceremony - // Don't use an iFrame! - // State can be stored/recovered using the framework's session or a - // query parameter on the returnUrl (see the makeRecipientViewRequest method) - return new RedirectView(viewUrl.getUrl()); - } - - private RecipientViewRequest makeRecipientViewRequest(String signerEmail, String signerName) { - RecipientViewRequest viewRequest = new RecipientViewRequest(); - // Set the url where you want the recipient to go once they are done signing - // should typically be a callback route somewhere in your app. - // The query parameter is included as an example of how - // to save/recover state information during the redirect to - // the DocuSign signing ceremony. It's usually better to use - // the session mechanism of your web framework. Query parameters - // can be changed/spoofed very easily. - viewRequest.setReturnUrl(config.getDsReturnUrl() + "?state=123"); - - // How has your app authenticated the user? In addition to your app's - // authentication, you can include authenticate steps from DocuSign. - // Eg, SMS authentication - viewRequest.setAuthenticationMethod("none"); - - // Recipient information must match embedded recipient info - // we used to create the envelope. - viewRequest.setEmail(signerEmail); - viewRequest.setUserName(signerName); - viewRequest.setClientUserId(SIGNER_CLIENT_ID); - - // DocuSign recommends that you redirect to DocuSign for the - // Signing Ceremony. There are multiple ways to save state. - // To maintain your application's session, use the pingUrl - // parameter. It causes the DocuSign Signing Ceremony web page - // (not the DocuSign server) to send pings via AJAX to your app. - // NOTE: The pings will only be sent if the pingUrl is an https address - viewRequest.setPingFrequency("600"); // seconds - viewRequest.setPingUrl(config.getDsPingUrl()); - - return viewRequest; - } - - private static EnvelopeDefinition makeEnvelope(String signerEmail, String signerName, String ccEmail, String ccName, String templateId) throws IOException { - // Create a signer recipient to sign the document, identified by name and email - // We set the clientUserId to enable embedded signing for the recipient - - List list1 = new List(); - list1.setValue("green"); - list1.setDocumentId("1"); - list1.setPageNumber("1"); - list1.setTabLabel("list"); - - // Checkboxes - Checkbox ck1 = new Checkbox(); - ck1.setTabLabel("ckAuthorization"); - ck1.setSelected("true"); - - Checkbox ck2 = new Checkbox(); - ck2.setTabLabel("ckAgreement"); - ck2.setSelected("true"); - - Radio radio = new Radio(); - radio.setValue("white"); - radio.setSelected("true"); - - RadioGroup rg = new RadioGroup(); - rg.setGroupName("radio1"); - rg.setRadios(Arrays.asList(radio)); - - - Text txt = new Text(); - txt.setTabLabel("text"); - txt.setValue("Jabberywocky!"); - - // We can also add a new tab (field) to the ones already in the template: - - Text txtExtra = new Text(); - txtExtra.setDocumentId("1"); - txtExtra.setPageNumber("1"); - txtExtra.setXPosition("280"); - txtExtra.setYPosition("172"); - txtExtra.setFont("helvetica"); - txtExtra.setFontSize("size14"); - txtExtra.setTabLabel("added text field"); - txtExtra.setHeight("23"); - txtExtra.setWidth("84"); - txtExtra.setRequired("false"); - txtExtra.setBold("true"); - txtExtra.setValue(signerName); - txtExtra.setLocked("false"); - txtExtra.setTabId("name"); - - - // Add the tabs model (including the SignHere tab) to the signer. - // The Tabs object wants arrays of the different field/tab types - // Tabs are set per recipient / signer - - Tabs tabs = new Tabs(); - - tabs.setTextTabs(Arrays.asList(txt, txtExtra)); - tabs.setRadioGroupTabs(Arrays.asList(rg)); - tabs.setCheckboxTabs(Arrays.asList(ck1, ck2)); - tabs.setListTabs(Arrays.asList(list1)); - - - // create a signer recipient to sign the document, identified by name and email - // We're setting the parameters via the object creation - TemplateRole signer = new TemplateRole(); - signer.setEmail(signerEmail); - signer.setName(signerName); - // Setting the client_user_id marks the signer as embedded - signer.setClientUserId(SIGNER_CLIENT_ID); - signer.setRoleName("signer"); - signer.setTabs(tabs); - - TemplateRole cc = new TemplateRole(); - cc.setEmail(ccEmail); - cc.setName(ccName); - cc.setRoleName("cc"); - - // Create an envelope custom field to save our application"s - // Data about the envelope - TextCustomField customField = new TextCustomField(); - customField.setName("app metadata item"); - customField.setValue("1234567"); - customField.setRequired("false"); - customField.show("true"); //Yes, include in the CoC - - - CustomFields cf = new CustomFields(); - cf.setTextCustomFields(Arrays.asList(customField)); - - - // Next, create the top level envelope definition and populate it. - EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); - envelopeDefinition.setEmailSubject("Please sign this document from the Java SDK"); - // The Recipients object wants arrays for each recipient type - envelopeDefinition.setTemplateId(templateId); - envelopeDefinition.setTemplateRoles(Arrays.asList(signer, cc)); - envelopeDefinition.setCustomFields(cf); - // Request that the envelope be sent by setting |status| to "sent". - // To request that the envelope be created as a draft, set to "created" - envelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - - return envelopeDefinition; - } -} diff --git a/src/main/java/com/docusign/controller/examples/EG019ControllerAccessCodeAuthentication.java b/src/main/java/com/docusign/controller/examples/EG019ControllerAccessCodeAuthentication.java deleted file mode 100644 index fbede6e0..00000000 --- a/src/main/java/com/docusign/controller/examples/EG019ControllerAccessCodeAuthentication.java +++ /dev/null @@ -1,109 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.Recipients; -import com.docusign.esign.model.SignHere; -import com.docusign.esign.model.Signer; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; -import java.io.IOException; -import java.util.Arrays; - -import javax.servlet.http.HttpServletResponse; - - -/** - * Send an envelope with a recipient using Access Code Authentication. Signer - * has to enter an access code for opening document to sign. - */ -@Controller -@RequestMapping("/eg019") -public class EG019ControllerAccessCodeAuthentication extends AbstractController { - - private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; - private static final String DOCUMENT_NAME = "Lorem"; - - private final Session session; - private final User user; - - - @Autowired - public EG019ControllerAccessCodeAuthentication(DSConfiguration config, Session session, User user) { - super(config, "eg019", "Signing request by email"); - this.session = session; - this.user = user; - } - - @Override - // ***DS.snippet.0.start - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - // Step 1: Construct your API headers - EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - - // Step 2: Construct your envelope JSON body - EnvelopeDefinition envelope = createEnvelope(args); - - // Step 3: Call the eSignature REST API - EnvelopeSummary results = envelopesApi.createEnvelope(session.getAccountId(), envelope); - - session.setEnvelopeId(results.getEnvelopeId()); - DoneExample.createDefault(title) - .withJsonObject(results) - .withMessage("The envelope has been created and sent!
Envelope ID " - + session.getEnvelopeId() + ".") - .addToModel(model); - - return DONE_EXAMPLE_PAGE; - } - - private static EnvelopeDefinition createEnvelope(WorkArguments args) throws IOException { - Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); - - SignHere signHere = new SignHere(); - signHere.setName("SignHereTab"); - signHere.setXPosition("75"); - signHere.setYPosition("572"); - signHere.setTabLabel("SignHereTab"); - signHere.setPageNumber("1"); - signHere.setDocumentId(doc.getDocumentId()); - // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your own systems. - // This value is referenced in the Tabs element below to assign tabs on a per-recipient basis. - signHere.setRecipientId("1"); - - Signer signer = new Signer(); - signer.setName(args.getSignerName()); - signer.setEmail(args.getSignerEmail()); - signer.setRoutingOrder("1"); - signer.setStatus(EnvelopeHelpers.SIGNER_STATUS_CREATED); - signer.setDeliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL); - signer.setRecipientId(signHere.getRecipientId()); - signer.setTabs(EnvelopeHelpers.createSignerTabs(signHere)); - signer.setAccessCode(args.getAccessCode()); - - Recipients recipients = new Recipients(); - recipients.setSigners(Arrays.asList(signer)); - - EnvelopeDefinition envelope = new EnvelopeDefinition(); - envelope.setEmailSubject("Please Sign"); - envelope.setDocuments(Arrays.asList(doc)); - envelope.setEnvelopeIdStamping("true"); - envelope.setEmailBlurb("Sample text for email body"); - envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - envelope.setRecipients(recipients); - - return envelope; - } - // ***DS.snippet.0.end -} diff --git a/src/main/java/com/docusign/controller/examples/EG020ControllerSmsAuthentication.java b/src/main/java/com/docusign/controller/examples/EG020ControllerSmsAuthentication.java deleted file mode 100644 index ae548bf7..00000000 --- a/src/main/java/com/docusign/controller/examples/EG020ControllerSmsAuthentication.java +++ /dev/null @@ -1,118 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.RecipientSMSAuthentication; -import com.docusign.esign.model.Recipients; -import com.docusign.esign.model.SignHere; -import com.docusign.esign.model.Signer; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; -import java.io.IOException; -import java.util.Arrays; -import java.util.List; - -import javax.servlet.http.HttpServletResponse; - - -/** - * Send an envelope with a recipient using SMS Authentication. - */ -@Controller -@RequestMapping("/eg020") -public class EG020ControllerSmsAuthentication extends AbstractController { - - private static final List RECIPIENT_PHONE_NUMBERS = List.of("415-555-1212", "415-555-3434"); - private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; - private static final String DOCUMENT_NAME = "Lorem"; - - private final Session session; - private final User user; - - - @Autowired - public EG020ControllerSmsAuthentication(DSConfiguration config, Session session, User user) { - super(config, "eg020", "Signing request by email"); - this.session = session; - this.user = user; - } - - @Override - // ***DS.snippet.0.start - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - String accountId = session.getAccountId(); - - // Step 2: Construct your API headers - EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - - // Step 3: Construct your envelope JSON body - EnvelopeDefinition envelope = createEnvelope(args.getSignerName(), args.getSignerEmail()); - - // Step 4: Call the eSignature REST API - EnvelopeSummary results = envelopesApi.createEnvelope(accountId, envelope); - - session.setEnvelopeId(results.getEnvelopeId()); - DoneExample.createDefault(title) - .withJsonObject(results) - .withMessage("The envelope has been created and sent!
Envelope ID " - + results.getEnvelopeId() + ".") - .addToModel(model); - - return DONE_EXAMPLE_PAGE; - } - - private static EnvelopeDefinition createEnvelope(String signerName, String signerEmail) throws IOException { - Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); - - SignHere signHere = new SignHere(); - signHere.setName("SignHereTab"); - signHere.setXPosition("75"); - signHere.setYPosition("572"); - signHere.setTabLabel("SignHereTab"); - signHere.setPageNumber("1"); - signHere.setDocumentId(doc.getDocumentId()); - // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your own systems. - // This value is referenced in the Tabs element below to assign tabs on a per-recipient basis. - signHere.setRecipientId("1"); - - RecipientSMSAuthentication smsAuth = new RecipientSMSAuthentication(); - smsAuth.setSenderProvidedNumbers(RECIPIENT_PHONE_NUMBERS); - - Signer signer = new Signer(); - signer.setName(signerName); - signer.setEmail(signerEmail); - signer.setRoutingOrder("1"); - signer.setStatus(EnvelopeHelpers.SIGNER_STATUS_CREATED); - signer.setDeliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL); - signer.setRecipientId(signHere.getRecipientId()); - signer.setTabs(EnvelopeHelpers.createSignerTabs(signHere)); - signer.setRequireIdLookup("true"); - signer.setSmsAuthentication(smsAuth); - signer.setIdCheckConfigurationName("SMS Auth $"); - - Recipients recipients = new Recipients(); - recipients.setSigners(Arrays.asList(signer)); - - EnvelopeDefinition envelope = new EnvelopeDefinition(); - envelope.setEmailSubject("Please Sign"); - envelope.setDocuments(Arrays.asList(doc)); - envelope.setEnvelopeIdStamping("true"); - envelope.setEmailBlurb("Sample text for email body"); - envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - envelope.setRecipients(recipients); - - return envelope; - } - // ***DS.snippet.0.end -} diff --git a/src/main/java/com/docusign/controller/examples/EG021ControllerPhoneAuthentication.java b/src/main/java/com/docusign/controller/examples/EG021ControllerPhoneAuthentication.java deleted file mode 100644 index f1341eb1..00000000 --- a/src/main/java/com/docusign/controller/examples/EG021ControllerPhoneAuthentication.java +++ /dev/null @@ -1,116 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.RecipientPhoneAuthentication; -import com.docusign.esign.model.Recipients; -import com.docusign.esign.model.SignHere; -import com.docusign.esign.model.Signer; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; -import java.io.IOException; -import java.util.Arrays; -import java.util.List; - -import javax.servlet.http.HttpServletResponse; - -/** - * Send an envelope with a recipient using Phone Authentication. - */ -@Controller -@RequestMapping("/eg021") -public class EG021ControllerPhoneAuthentication extends AbstractController { - - private static final List RECIPIENT_PHONE_NUMBERS = List.of("415-555-1212", "415-555-3434"); - private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; - private static final String DOCUMENT_NAME = "Lorem"; - - private final Session session; - private final User user; - - - @Autowired - public EG021ControllerPhoneAuthentication(DSConfiguration config, Session session, User user) { - super(config, "eg021", "Signing request by email"); - this.session = session; - this.user = user; - } - - @Override - // ***DS.snippet.0.start - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - // Step 1: Construct your API headers - EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - - // Step 2: Construct your envelope JSON body - EnvelopeDefinition envelope = createEnvelope(args.getSignerName(), args.getSignerEmail()); - - // Step 3: Call the eSignature REST API - EnvelopeSummary results = envelopesApi.createEnvelope(session.getAccountId(), envelope); - - session.setEnvelopeId(results.getEnvelopeId()); - DoneExample.createDefault(title) - .withJsonObject(results) - .withMessage("The envelope has been created and sent!
Envelope ID " - + results.getEnvelopeId() + ".") - .addToModel(model); - - return DONE_EXAMPLE_PAGE; - } - - private static EnvelopeDefinition createEnvelope(String signerName, String signerEmail) throws IOException { - Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); - - SignHere signHere = new SignHere(); - signHere.setName("SignHereTab"); - signHere.setXPosition("75"); - signHere.setYPosition("572"); - signHere.setTabLabel("SignHereTab"); - signHere.setPageNumber("1"); - signHere.setDocumentId(doc.getDocumentId()); - // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your own systems. - // This value is referenced in the Tabs element below to assign tabs on a per-recipient basis. - signHere.setRecipientId("1"); - - RecipientPhoneAuthentication phoneAuth = new RecipientPhoneAuthentication(); - phoneAuth.setRecipMayProvideNumber("true"); - phoneAuth.setSenderProvidedNumbers(RECIPIENT_PHONE_NUMBERS); - - Signer signer = new Signer(); - signer.setName(signerName); - signer.setEmail(signerEmail); - signer.setRoutingOrder("1"); - signer.setStatus(EnvelopeHelpers.SIGNER_STATUS_CREATED); - signer.setDeliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL); - signer.setRecipientId(signHere.getRecipientId()); - signer.setTabs(EnvelopeHelpers.createSignerTabs(signHere)); - signer.setRequireIdLookup("true"); - signer.setPhoneAuthentication(phoneAuth); - signer.setIdCheckConfigurationName("Phone Auth $"); - - Recipients recipients = new Recipients(); - recipients.setSigners(Arrays.asList(signer)); - - EnvelopeDefinition envelope = new EnvelopeDefinition(); - envelope.setEmailSubject("Please Sign"); - envelope.setEnvelopeIdStamping("true"); - envelope.setEmailBlurb("Sample text for email body"); - envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - envelope.setRecipients(recipients); - envelope.setDocuments(Arrays.asList(doc)); - - return envelope; - } - // ***DS.snippet.0.end -} diff --git a/src/main/java/com/docusign/controller/examples/EG022ControllerKBAAuthentication.java b/src/main/java/com/docusign/controller/examples/EG022ControllerKBAAuthentication.java deleted file mode 100644 index dad45c63..00000000 --- a/src/main/java/com/docusign/controller/examples/EG022ControllerKBAAuthentication.java +++ /dev/null @@ -1,109 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.Recipients; -import com.docusign.esign.model.SignHere; -import com.docusign.esign.model.Signer; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; -import java.io.IOException; -import java.util.Arrays; - -import javax.servlet.http.HttpServletResponse; - - -/** - * Send an envelope with a recipient using Knowledge-Based Authentication. - */ -@Controller -@RequestMapping("/eg022") -public class EG022ControllerKBAAuthentication extends AbstractController { - - private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; - private static final String DOCUMENT_NAME = "Lorem"; - - private final Session session; - private final User user; - - - @Autowired - public EG022ControllerKBAAuthentication(DSConfiguration config, Session session, User user) { - super(config, "eg022", "Signing request by email"); - this.session = session; - this.user = user; - } - - @Override - // ***DS.snippet.0.start - protected Object doWork(WorkArguments args, ModelMap model, - HttpServletResponse response) throws ApiException, IOException { - // Step 1: Construct your API headers - EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - - // Step 2: Construct your envelope JSON body - EnvelopeDefinition envelope = createEnvelope(args.getSignerName(), args.getSignerEmail()); - - // Step 3: Call the eSignature REST API - EnvelopeSummary results = envelopesApi.createEnvelope(session.getAccountId(), envelope); - - session.setEnvelopeId(results.getEnvelopeId()); - DoneExample.createDefault(title) - .withJsonObject(results) - .withMessage("The envelope has been created and sent!
Envelope ID " - + results.getEnvelopeId() + ".") - .addToModel(model); - - return DONE_EXAMPLE_PAGE; - } - - private static EnvelopeDefinition createEnvelope(String signerName, String signerEmail) throws IOException { - Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); - - SignHere signHere = new SignHere(); - signHere.setName("SignHereTab"); - signHere.setXPosition("75"); - signHere.setYPosition("572"); - signHere.setTabLabel("SignHereTab"); - signHere.setPageNumber("1"); - signHere.setDocumentId(doc.getDocumentId()); - // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your own systems. - // This value is referenced in the Tabs element below to assign tabs on a per-recipient basis. - signHere.setRecipientId("1"); - - Signer signer = new Signer(); - signer.setName(signerName); - signer.setEmail(signerEmail); - signer.setRoutingOrder("1"); - signer.setStatus(EnvelopeHelpers.SIGNER_STATUS_CREATED); - signer.setDeliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL); - signer.setRecipientId(signHere.getRecipientId()); - signer.setTabs(EnvelopeHelpers.createSignerTabs(signHere)); - signer.setIdCheckConfigurationName("ID Check"); - signer.setRequireIdLookup("true"); - - Recipients recipients = new Recipients(); - recipients.setSigners(Arrays.asList(signer)); - - EnvelopeDefinition envelope = new EnvelopeDefinition(); - envelope.setEmailSubject("Please Sign"); - envelope.setEnvelopeIdStamping("true"); - envelope.setEmailBlurb("Sample text for email body"); - envelope.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - envelope.setDocuments(Arrays.asList(doc)); - envelope.setRecipients(recipients); - - return envelope; - } - // ***DS.snippet.0.end -} diff --git a/src/main/java/com/docusign/controller/examples/EG023ControllerIdvAuthentication.java b/src/main/java/com/docusign/controller/examples/EG023ControllerIdvAuthentication.java deleted file mode 100644 index 2efc8d62..00000000 --- a/src/main/java/com/docusign/controller/examples/EG023ControllerIdvAuthentication.java +++ /dev/null @@ -1,138 +0,0 @@ -package com.docusign.controller.examples; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.AccountsApi; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiClient; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.AccountIdentityVerificationResponse; -import com.docusign.esign.model.AccountIdentityVerificationWorkflow; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.RecipientIdentityVerification; -import com.docusign.esign.model.Recipients; -import com.docusign.esign.model.SignHere; -import com.docusign.esign.model.Signer; -import com.docusign.esign.model.Tabs; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; - -import java.io.IOException; -import java.util.Base64; -import java.util.Collections; -import java.util.List; -import javax.servlet.http.HttpServletResponse; - -/** - * ID Verification authentication - */ -@Controller -@RequestMapping("/eg023") -public class EG023ControllerIdvAuthentication extends AbstractController { - - private static final Logger logger = LoggerFactory.getLogger(EG023ControllerIdvAuthentication.class); - private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; - private static final String DOCUMENT_NAME = "Lorem"; - private final Session session; - private final User user; - - @Autowired - public EG023ControllerIdvAuthentication(DSConfiguration config, Session session, User user) { - super(config, "eg023", "ID Verification Authentication"); - this.session = session; - this.user = user; - } - - @Override - protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException, IOException { - // Step 1: Construct your API headers - ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); - EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); - //Step 2: Retrieve the workflow ID - AccountsApi workflowDetails = new AccountsApi(apiClient); - AccountIdentityVerificationResponse workflowRes = workflowDetails.getAccountIdentityVerification(session.getAccountId()); - List identityVerification = workflowRes.getIdentityVerification(); - if (identityVerification == null || identityVerification.isEmpty()) { - throw new ApiException("Error. Cant get AccountIdentityVerificationWorkflow"); - } - String workflowId = identityVerification.get(0).getWorkflowId(); - logger.info("workflowId = " + workflowId); - // Step 3: Construct your envelope JSON body - EnvelopeDefinition envelope = createEnvelope(args.getSignerName(), args.getSignerEmail(), workflowId); - // Step 4: Create envelope - EnvelopeSummary results = envelopesApi.createEnvelope(session.getAccountId(), envelope); - - session.setEnvelopeId(results.getEnvelopeId()); - DoneExample.createDefault(title) - .withJsonObject(results) - .withMessage("The envelope has been created and sent!
Envelope ID " - + results.getEnvelopeId() + ".") - .addToModel(model); - - return DONE_EXAMPLE_PAGE; - } - - private static EnvelopeDefinition createEnvelope(String signerName, String signerEmail, - String workflowId) { - EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition(); - envelopeDefinition.setEmailSubject("Please sign"); - envelopeDefinition.setEmailBlurb("Sample text for email body"); - envelopeDefinition.setStatus("Sent"); - - - byte[] fileBytes = new byte[0]; - try { - fileBytes = EnvelopeHelpers.readFile(DOCUMENT_FILE_NAME); - } catch (IOException e) { - e.printStackTrace(); - } - Document doc1 = new Document(); - doc1.setDocumentBase64(Base64.getEncoder().encodeToString(fileBytes)); - doc1.setDocumentId("1"); - doc1.setFileExtension("pdf"); - doc1.setName("Lorem"); - - SignHere signHere1 = new SignHere(); - signHere1.setName("SignHereTab"); - signHere1.setXPosition("75"); - signHere1.setYPosition("572"); - signHere1.setTabLabel("SignHereTab"); - signHere1.setPageNumber("1"); - signHere1.setDocumentId("1"); - // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your own systems. - // This value is referenced in the Tabs element below to assign tabs on a per-recipient basis. - signHere1.setRecipientId("1"); //represents your {RECIPIENT_ID} - - Tabs signer1Tabs = new Tabs(); - signer1Tabs.setSignHereTabs(Collections.singletonList(signHere1)); - RecipientIdentityVerification workflow = new RecipientIdentityVerification(); - workflow.setWorkflowId(workflowId); - - Signer signer1 = new Signer(); - signer1.setName(signerName); - signer1.setEmail(signerEmail); - signer1.setRoleName(""); - signer1.setNote(""); - signer1.setStatus("created"); - signer1.setDeliveryMethod("email"); - signer1.setRecipientId("1"); //represents your {RECIPIENT_ID} - signer1.setIdentityVerification(workflow); - signer1.setTabs(signer1Tabs); - - Recipients recipients = new Recipients(); - recipients.setSigners(Collections.singletonList(signer1)); - - envelopeDefinition.setRecipients(recipients); - //TODO: Uncomment - //envelopeDefinition.setDocuments(Collections.singletonList(doc1)); - return envelopeDefinition; - } -} diff --git a/src/main/java/com/docusign/controller/examples/EG026ControllerPermissionChangeSingleSetting.java b/src/main/java/com/docusign/controller/examples/EG026ControllerPermissionChangeSingleSetting.java deleted file mode 100644 index 8844ec59..00000000 --- a/src/main/java/com/docusign/controller/examples/EG026ControllerPermissionChangeSingleSetting.java +++ /dev/null @@ -1,132 +0,0 @@ -package com.docusign.controller.examples; - -import java.io.IOException; -import java.util.List; -import java.util.NoSuchElementException; -import java.util.Objects; -import java.util.Optional; -import java.util.Random; - -import javax.servlet.http.HttpServletResponse; - -import com.docusign.model.AccountRoleSettingsPatch; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.RequestParam; - -import com.docusign.DSConfiguration; -import com.docusign.common.Utils; -import com.docusign.esign.api.AccountsApi; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.AccountRoleSettings; -import com.docusign.esign.model.PermissionProfile; -import com.docusign.esign.model.PermissionProfileInformation; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; -import com.google.gson.Gson; - -/** - * This code example demonstrates how to edit individual permission settings on - * a permission profile with the eSignature REST API. - */ -@Controller -@RequestMapping("/eg026") -public class EG026ControllerPermissionChangeSingleSetting extends AbstractController { - - private static final String MODEL_PERMISSIONS = "permissions"; - private static final String MODEL_CUR_PROFILE_NAME = "permissionProfileName"; - private static final String MODEL_CUR_PROFILE_ID = "profileId"; - private static final String MODEL_LIST_PROFILES = "listProfiles"; - - private final Session session; - private final User user; - - @Autowired - public EG026ControllerPermissionChangeSingleSetting(DSConfiguration config, Session session, User user) { - super(config, "eg026", "Change single permission setting"); - this.session = session; - this.user = user; - } - - @GetMapping("/profile") - public void getProfile(@RequestParam String profileId, ModelMap model) { - session.setPermissionProfileId(profileId); - model.addAttribute(MODEL_CUR_PROFILE_NAME, profileId); - } - - @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { - super.onInitModel(args, model); - AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); - - PermissionProfileInformation permissionsInfo = accountsApi.listPermissions(session.getAccountId()); - List profiles = permissionsInfo.getPermissionProfiles(); - model.addAttribute(MODEL_LIST_PROFILES, profiles); - - model.addAttribute(MODEL_CUR_PROFILE_NAME, profiles.get(0).getPermissionProfileName()); - model.addAttribute(MODEL_CUR_PROFILE_ID, profiles.get(0).getPermissionProfileId()); - findProfile(profiles, session.getPermissionProfileId()).ifPresent((PermissionProfile curProfile) -> { - model.addAttribute(MODEL_CUR_PROFILE_NAME, curProfile.getPermissionProfileName()); - model.addAttribute(MODEL_CUR_PROFILE_ID, curProfile.getPermissionProfileId()); - // model.addAttribute(MODEL_PERMISSIONS, - // Utils.compareFields(curProfile.getSettings(), null, true)); - }); - } - - @Override - protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) - throws ApiException, IOException { - // Step 2. Construct your API headers - AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); - String accountId = session.getAccountId(); - String curProfileId = args.getProfileId(); - - // Step 3. Construct your request body - PermissionProfileInformation permissionsInfo = accountsApi.listPermissions(accountId); - PermissionProfile profile = findProfile(permissionsInfo.getPermissionProfiles(), curProfileId) - .orElseThrow(NoSuchElementException::new); - - // Step 4. Call the eSignature REST API - AccountRoleSettings newSettings = Objects.requireNonNullElse(profile.getSettings(), - DsModelUtils.createDefaultRoleSettings()); - profile.setSettings(changeRandomSettings(newSettings)); - PermissionProfile newProfile = accountsApi.updatePermissionProfile(accountId, curProfileId, profile); - - DoneExample.createDefault(title).withMessage("The permission profile is updated!
Permission profile ID: " - + newProfile.getPermissionProfileId() + ".").addToModel(model); - return DONE_EXAMPLE_PAGE_COMPARE; - } - - private static Optional findProfile(List profiles, String profileId) { - - return profiles.stream().filter(p -> p.getPermissionProfileId().equals(profileId)).findFirst(); - } - - // Changes random boolean properties; in a real application, changing properties - // will be read from the page or in a different way - private static AccountRoleSettings changeRandomSettings(AccountRoleSettings settings) { - Gson gson = new Gson(); - // Change this value back to: gson.fromJson(gson.toJson(settings), - // AccountRoleSettings.class); - // as soon as the signinguiversion is added back to the swagger spec. - AccountRoleSettings newSettings = gson.fromJson(gson.toJson(settings), AccountRoleSettingsPatch.class); - Random random = new Random(System.currentTimeMillis()); - - return newSettings.canCreateWorkspaces(randomBool(random)).allowEnvelopeSending(randomBool(random)) - .allowSignerAttachments(randomBool(random)).allowESealRecipients(randomBool(random)) - .allowTaggingInSendAndCorrect(randomBool(random)).allowWetSigningOverride(randomBool(random)) - .enableApiRequestLogging(randomBool(random)).enableRecipientViewingNotifications(randomBool(random)) - .allowSupplementalDocuments(randomBool(random)).disableDocumentUpload(randomBool(random)); - } - - private static String randomBool(Random random) { - if (random.nextBoolean()) { - return DsModelUtils.TRUE; - } - return DsModelUtils.FALSE; - } -} diff --git a/src/main/java/com/docusign/controller/examples/EG029ControllerApplyBrandToEnvelope.java b/src/main/java/com/docusign/controller/examples/EG029ControllerApplyBrandToEnvelope.java deleted file mode 100644 index c06732e2..00000000 --- a/src/main/java/com/docusign/controller/examples/EG029ControllerApplyBrandToEnvelope.java +++ /dev/null @@ -1,112 +0,0 @@ -package com.docusign.controller.examples; - -import java.io.IOException; -import java.util.Arrays; -import java.util.List; - -import javax.servlet.http.HttpServletResponse; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.AccountsApi; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.BrandsResponse; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.EnvelopeSummary; -import com.docusign.esign.model.Recipients; -import com.docusign.esign.model.Signer; -import com.docusign.esign.model.Tabs; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - - -/** - * Applying a brand to an envelope
- * The envelope includes a pdf document. Anchor text AutoPlace is used - * to position the signing fields in the documents. - */ -@Controller -@RequestMapping("/eg029") -public class EG029ControllerApplyBrandToEnvelope extends AbstractController { - - private static final String MODEL_LIST_BRAND = "listBrands"; - private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; - private static final String DOCUMENT_NAME = "EG025 Lorem Ipsum"; - private static final int ANCHOR_OFFSET_Y = 10; - private static final int ANCHOR_OFFSET_X = 20; - - private final Session session; - private final User user; - - - @Autowired - public EG029ControllerApplyBrandToEnvelope(DSConfiguration config, Session session, User user) { - super(config, "eg029", "Apply brand to envelope"); - this.session = session; - this.user = user; - } - - @Override - protected void onInitModel(WorkArguments args, ModelMap model) throws ApiException { - super.onInitModel(args, model); - AccountsApi accountsApi = createAccountsApi(session.getBasePath(), user.getAccessToken()); - BrandsResponse brands = accountsApi.listBrands(session.getAccountId()); - model.addAttribute(MODEL_LIST_BRAND, brands.getBrands()); - } - - @Override - protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) - throws ApiException, IOException { - // Step 2: Construct your API headers - EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken()); - - // Step 3: Construct your envelope JSON body - EnvelopeDefinition envelope = makeEnvelope(args); - - // Step 5: Call the eSignature REST API - EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(session.getAccountId(), envelope); - - DoneExample.createDefault(title) - .withJsonObject(envelopeSummary) - .withMessage("The envelope has been created and sent!
Envelope ID " - + envelopeSummary.getEnvelopeId() + ".") - .addToModel(model); - return DONE_EXAMPLE_PAGE; - } - - // Creates an envelope. The envelope has one recipient who should sign an - // attached document. Attached document is read from a local directory. - // Also the envelope contains a brand Id which is created on EG024 example. - private static EnvelopeDefinition makeEnvelope(WorkArguments args) throws IOException { - // Reads a file from a local directory and create Document object. - Document document = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, "1"); - - // Create a signer recipient to sign the document and associate sign tab - Tabs tabs = EnvelopeHelpers.createSingleSignerTab("/sn1/", ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X); - Signer signer = new Signer() - .email(args.getSignerEmail()) - .name(args.getSignerName()) - .recipientId("1") - .routingOrder("1") - .tabs(tabs); - - Recipients recipients = new Recipients(); - recipients.setSigners(Arrays.asList(signer)); - - // Return envelope definition using created objects: the document, - // the recipients and obtained brand Id. - return new EnvelopeDefinition() - .emailSubject("EG025. Please complete your order") - .documents(List.of(document)) - .recipients(recipients) - .brandId(args.getBrandId()) - .status(EnvelopeHelpers.ENVELOPE_STATUS_SENT); - } -} diff --git a/src/main/java/com/docusign/controller/examples/EG031ControllerBulkSendEnvelopes.java b/src/main/java/com/docusign/controller/examples/EG031ControllerBulkSendEnvelopes.java deleted file mode 100644 index a43a1de1..00000000 --- a/src/main/java/com/docusign/controller/examples/EG031ControllerBulkSendEnvelopes.java +++ /dev/null @@ -1,176 +0,0 @@ -package com.docusign.controller.examples; - -import java.io.IOException; -import java.util.Collections; -import java.util.List; -import java.util.concurrent.TimeUnit; - -import javax.servlet.http.HttpServletResponse; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Controller; -import org.springframework.ui.ModelMap; -import org.springframework.web.bind.annotation.RequestMapping; - -import com.docusign.DSConfiguration; -import com.docusign.esign.api.BulkEnvelopesApi; -import com.docusign.esign.api.EnvelopesApi; -import com.docusign.esign.client.ApiClient; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.model.BulkEnvelopeStatus; -import com.docusign.esign.model.BulkSendRequest; -import com.docusign.esign.model.BulkSendingCopy; -import com.docusign.esign.model.BulkSendingCopyRecipient; -import com.docusign.esign.model.BulkSendingList; -import com.docusign.esign.model.CustomFields; -import com.docusign.esign.model.Document; -import com.docusign.esign.model.EnvelopeDefinition; -import com.docusign.esign.model.Recipients; -import com.docusign.esign.model.Signer; -import com.docusign.esign.model.TextCustomField; -import com.docusign.model.DoneExample; -import com.docusign.model.Session; -import com.docusign.model.User; - -/** - * This code example demonstrates how to send envelopes in bulk to multiple - * recipients with the eSignature API. To accomplish the task, you will first - * create a bulk send recipients list, and then create an envelope. From there, - * you will combine the envelope and bulk list to initiate bulk send - */ -@Controller -@RequestMapping("/eg031") -public class EG031ControllerBulkSendEnvelopes extends AbstractController { - - private static final long BULK_REQUEST_DELAY = 15L; - private static final String BULK_SIGNER_EMAIL_PLACEHOLDER = "MultiBulkRecipients-%s@docusign.com"; - private static final String BULK_SIGNER_NAME_PLACEHOLDER = "Multi Bulk Recipients::%s"; - private static final String DOCX_DOCUMENT_FILE_NAME = "World_Wide_Corp_Battle_Plan_Trafalgar.docx"; - private static final String DOCX_DOCUMENT_NAME = "Battle Plan"; - - private final Session session; - private final User user; - - - @Autowired - public EG031ControllerBulkSendEnvelopes(DSConfiguration config, Session session, User user) { - super(config, "eg031", "Bulk sending envelopes to multiple recipients"); - this.session = session; - this.user = user; - } - - @Override - protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) - throws ApiException, IOException { - - // Step 2. Construct your API headers - ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken()); - String accountId = session.getAccountId(); - - // Step 3. Submit a bulk list - BulkEnvelopesApi bulkEnvelopesApi = new BulkEnvelopesApi(apiClient); - BulkSendingList sendingList = getSendingList(args); - String bulkListId = bulkEnvelopesApi.createBulkSendList(accountId, sendingList).getListId(); - - // Step 4. Create an envelope - EnvelopesApi envelopesApi = new EnvelopesApi(apiClient); - String envelopeId = envelopesApi.createEnvelope(accountId, makeEnvelope()).getEnvelopeId(); - - // Step 5. Attach your bulk list ID to the envelope - CustomFields customFields = createCustomFields(bulkListId); - envelopesApi.createCustomFields(accountId, envelopeId, customFields); - - // Step 6. Add placeholder recipients - envelopesApi.createRecipient(accountId, envelopeId, createRecipients()); - - // Step 7. Initiate bulk send - BulkSendRequest request = new BulkSendRequest(); - request.setEnvelopeOrTemplateId(envelopeId); - String batchId = bulkEnvelopesApi.createBulkSendRequest(accountId, bulkListId, request).getBatchId(); - - // Step 8. Confirm successful bulk send - try { - TimeUnit.SECONDS.sleep(BULK_REQUEST_DELAY); - // For 2000 recipients, it can take about an hour - BulkEnvelopeStatus status = bulkEnvelopesApi.get(accountId, batchId); - DoneExample.createDefault(title) - .withJsonObject(status) - .withMessage(String.join("", "Bulk request was sent to ", status.getSent(), " user lists.")) - .addToModel(model); - } catch (InterruptedException exception) { - Thread.currentThread().interrupt(); - return null; - } - - return DONE_EXAMPLE_PAGE; - } - - private static BulkSendingList getSendingList(WorkArguments args) { - List copies = List.of( - createBulkSending(args.getSignerName(), args.getSignerEmail(), args.getCcName(), args.getCcEmail()), - createBulkSending(args.getSignerName2(), args.getSignerEmail2(), args.getCcName2(), args.getCcEmail2()) - ); - return new BulkSendingList() - .name("sample.csv") - .bulkCopies(copies); - } - - private static BulkSendingCopy createBulkSending(String signerName, - String signerEmail, String ccName, String ccEmail) { - BulkSendingCopyRecipient recipient1 = new BulkSendingCopyRecipient() - .name(signerName) - .email(signerEmail) - .tabs(Collections.emptyList()) - .roleName(EnvelopeHelpers.SIGNER_ROLE_NAME); - BulkSendingCopyRecipient recipient2 = new BulkSendingCopyRecipient() - .name(ccName) - .email(ccEmail) - .tabs(Collections.emptyList()) - .roleName(EnvelopeHelpers.CC_ROLE_NAME); - return new BulkSendingCopy() - .recipients(List.of(recipient1, recipient2)) - .customFields(Collections.emptyList()); - } - - private static EnvelopeDefinition makeEnvelope() throws IOException { - Document document = EnvelopeHelpers.createDocumentFromFile(DOCX_DOCUMENT_FILE_NAME, DOCX_DOCUMENT_NAME, "1"); - return new EnvelopeDefinition() - .documents(List.of(document)) - .envelopeIdStamping(DsModelUtils.TRUE) - .emailSubject("EG031 Please sign") - .status(EnvelopeHelpers.ENVELOPE_STATUS_CREATED); - } - - private static CustomFields createCustomFields(String bulkListId) { - TextCustomField textCustomField = new TextCustomField() - .name("mailingListId") - .required(DsModelUtils.FALSE) - .show(DsModelUtils.FALSE) - .value(bulkListId); - - return new CustomFields() - .listCustomFields(Collections.emptyList()) - .textCustomFields(List.of(textCustomField)); - } - - private static Recipients createRecipients() { - List signers = List.of( - createSignerPlaceholder(EnvelopeHelpers.SIGNER_ROLE_NAME, "1"), - createSignerPlaceholder(EnvelopeHelpers.CC_ROLE_NAME, "2")); - return new Recipients() - .signers(signers); - } - - private static Signer createSignerPlaceholder(String roleName, String recipientId) { - return new Signer() - .name(String.format(BULK_SIGNER_NAME_PLACEHOLDER, roleName)) - .email(String.format(BULK_SIGNER_EMAIL_PLACEHOLDER, roleName)) - .roleName(roleName) - .note("") - .routingOrder("1") - .status(EnvelopeHelpers.SIGNER_STATUS_CREATED) - .deliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL) - .recipientId(recipientId) - .recipientType(EnvelopeHelpers.SIGNER_ROLE_NAME); - } -} \ No newline at end of file diff --git a/src/main/java/com/docusign/controller/examples/WorkArguments.java b/src/main/java/com/docusign/controller/examples/WorkArguments.java deleted file mode 100644 index 8d3d3200..00000000 --- a/src/main/java/com/docusign/controller/examples/WorkArguments.java +++ /dev/null @@ -1,38 +0,0 @@ -package com.docusign.controller.examples; - -import org.springframework.context.annotation.Scope; -import org.springframework.stereotype.Component; -import org.springframework.web.context.WebApplicationContext; - -import lombok.Data; - - -@Component -@Scope(value = WebApplicationContext.SCOPE_REQUEST) -@Data -public class WorkArguments { - private String item; - private String quantity; - private String signerEmail; - private String signerName; - private String ccEmail; - private String ccName; - private String signerEmail2; - private String signerName2; - private String ccEmail2; - private String ccName2; - private String status; - private String startingView; - private String dsReturnUrl; - private String dsPingUrl; - private String signerClientId; - private String docSelect; - private String accessCode; - private String brandName; - private String language; - private String brandId; - private String templateId; - private String profileId; - private String groupId; - private String permissionProfileName; -} diff --git a/src/main/java/com/docusign/controller/monitor/examples/AbstractMonitorController.java b/src/main/java/com/docusign/controller/monitor/examples/AbstractMonitorController.java new file mode 100644 index 00000000..c7a5dffb --- /dev/null +++ b/src/main/java/com/docusign/controller/monitor/examples/AbstractMonitorController.java @@ -0,0 +1,67 @@ +package com.docusign.controller.monitor.examples; + +import com.docusign.DSConfiguration; +import com.docusign.core.controller.AbstractController; +import com.docusign.core.model.AuthType; +import com.docusign.core.model.Session; +import com.docusign.monitor.api.DataSetApi; +import com.docusign.monitor.client.ApiClient; +import org.springframework.http.HttpHeaders; +import org.springframework.stereotype.Controller; +import org.springframework.web.servlet.ModelAndView; + +/** + * Abstract base class for all Monitor controllers. + */ +@Controller +public abstract class AbstractMonitorController extends AbstractController { + + private static final String EXAMPLE_PAGES_PATH = "pages/monitor/examples/"; + + public AbstractMonitorController(DSConfiguration config, String exampleName) { + super(config, exampleName); + } + + protected String getExamplePagesPath() { + return AbstractMonitorController.EXAMPLE_PAGES_PATH; + } + + protected ModelAndView ensureUsageOfJWTToken(String accessToken, Session session) { + if (session.getAuthTypeSelected() != AuthType.JWT || accessToken.isEmpty()) { + return new ModelAndView("pages/ds_must_authenticate"); + } + + return null; + } + + /** + * Creates new instance of the Monitor API client. + * + * @param accessToken user's access token + * @param session active session + * @return an instance of the {@link com.docusign.monitor.client.ApiClient} + */ + protected ApiClient createApiClient(String accessToken, Session session) { + + //ds-snippet-start:Monitor1Step2 + ApiClient apiClient = new ApiClient(config.getMonitorBasePath()); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + accessToken); + apiClient.setBasePath(config.getMonitorBasePath()); + //ds-snippet-end:Monitor1Step2 + return apiClient; + } + + /** + * Creates a new instance of the DataSetApi. This method + * creates an instance of the ApiClient class silently. + * + * @param accessToken user's access token + * @param session active session + * @return an instance of the {@link DataSetApi} + */ + protected DataSetApi createDataSetApi(String accessToken, Session session) { + ApiClient apiClient = createApiClient(accessToken, session); + return new DataSetApi(apiClient); + } +} + diff --git a/src/main/java/com/docusign/controller/monitor/examples/M001GetMonitoringData.java b/src/main/java/com/docusign/controller/monitor/examples/M001GetMonitoringData.java new file mode 100644 index 00000000..bb88169e --- /dev/null +++ b/src/main/java/com/docusign/controller/monitor/examples/M001GetMonitoringData.java @@ -0,0 +1,64 @@ +package com.docusign.controller.monitor.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.monitor.services.GetMonitoringDataService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import org.json.JSONArray; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; + +/** + * Get monitoring data
+ * This example demonstrates how to get monitoring data from the Monitor API. + */ +@Controller +@RequestMapping("/m001") +public class M001GetMonitoringData extends AbstractMonitorController { + + private final Session session; + + private final User user; + + @Autowired + public M001GetMonitoringData(DSConfiguration config, Session session, User user) { + super(config, "m001"); + this.session = session; + this.user = user; + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws Exception { + String accessToken = this.user.getAccessToken(); + + // Check, if you are using the JWT authentication + ensureUsageOfJWTToken(accessToken, this.session); + JSONArray monitoringData = GetMonitoringDataService.getMonitoringData(createDataSetApi(accessToken, this.session)); + + if (monitoringData.getJSONObject(0).has("Error")) { + new DoneExample() + .withTitle(getTextForCodeExample().ExampleName) + .withName("") + .withMessage(monitoringData.getJSONObject(0).getString("Error")) + .addToModel(model, config); + return ERROR_PAGE; + } + + // Cleaning the data from wrong symbols + String monitoringDataCleaned = monitoringData.toString().replaceAll("'", ""); + + // Process results + DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(monitoringDataCleaned) + .addToModel(model, config); + + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/monitor/services/GetMonitoringDataService.java b/src/main/java/com/docusign/controller/monitor/services/GetMonitoringDataService.java new file mode 100644 index 00000000..a6c158b4 --- /dev/null +++ b/src/main/java/com/docusign/controller/monitor/services/GetMonitoringDataService.java @@ -0,0 +1,58 @@ +package com.docusign.controller.monitor.services; + +import com.docusign.monitor.api.DataSetApi; +import com.docusign.monitor.model.CursoredResult; +import org.json.JSONArray; +import org.json.JSONObject; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public final class GetMonitoringDataService { + private static final Logger LOGGER = LoggerFactory.getLogger(GetMonitoringDataService.class); + + public static JSONArray getMonitoringData(DataSetApi datasetApi) throws Exception { + // Declare variables + boolean complete = false; + String cursorValue = ""; + JSONArray monitoringData = new JSONArray(); + + LOGGER.info("before optinos"); + DataSetApi.GetStreamOptions options = datasetApi.new GetStreamOptions(); + + // First call the endpoint with no cursor to get the first records. + // After each call, save the cursor and use it to make the next + // call from the point where the previous one left off when iterating through + // the monitoring records + try { + //ds-snippet-start:Monitor1Step3 + do { + if (!cursorValue.isEmpty()) { + options.setCursor(cursorValue); + } + + LOGGER.info("options set: " + options); + CursoredResult cursoredResult = datasetApi.getStream("2.0", "monitor", options); + LOGGER.info("cursor results " + cursoredResult); + String endCursor = cursoredResult.getEndCursor(); + + // If the endCursor from the response is the same as the one that you already have, + // it means that you have reached the end of the records + if (endCursor.equals(cursorValue)) { + complete = true; + } else { + cursorValue = endCursor; + monitoringData.put(new JSONObject(cursoredResult)); + } + } + while (!complete); + //ds-snippet-end:Monitor1Step3 + } catch (Exception e) { + LOGGER.error(String.valueOf(e)); + JSONObject jsonObject = new JSONObject(); + jsonObject.put("Error", "You do not have Monitor enabled for your account, follow How to enable Monitor for your account to get it enabled."); + monitoringData.put(jsonObject); + } + + return monitoringData; + } +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/AbstractRoomsController.java b/src/main/java/com/docusign/controller/rooms/examples/AbstractRoomsController.java new file mode 100644 index 00000000..f1ffa046 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/AbstractRoomsController.java @@ -0,0 +1,143 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.core.controller.AbstractController; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.rooms.api.*; +import com.docusign.rooms.client.ApiClient; +import com.docusign.rooms.client.auth.OAuth; +import org.springframework.http.HttpHeaders; +import org.springframework.stereotype.Controller; + + +/** + * Abstract base class for all Rooms controllers. + */ +@Controller +public abstract class AbstractRoomsController extends AbstractController { + + private static final String EXAMPLE_PAGES_PATH = "pages/rooms/examples/"; + + protected Session session; + + protected User user; + + public AbstractRoomsController(DSConfiguration config, String exampleName) { + super(config, exampleName); + } + + /** + * Creates new instance of the Rooms API client. + * + * @param basePath URL to eSignature REST API + * @param userAccessToken user's access token + * @return an instance of the {@link ApiClient} + */ + + //ds-snippet-start:RoomsJavaStep2 + protected static ApiClient createApiClient(String basePath, String userAccessToken) { + ApiClient apiClient = new ApiClient(basePath); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + userAccessToken); + apiClient.addAuthorization("docusignAccessCode", new OAuth()); + return apiClient; + } + + /** + * Creates a new instance of the RoomsApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to Rooms REST API + * @param userAccessToken user's access token + * @return an instance of the {@link RoomsApi} + */ + protected static RoomsApi createRoomsApiClient(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new RoomsApi(apiClient); + } + + /** + * Creates a new instance of the rooms RolesApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to Rooms REST API + * @param userAccessToken user's access token + * @return an instance of the {@link RolesApi} + */ + protected static RolesApi createRolesApiClient(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new RolesApi(apiClient); + } + //ds-snippet-end:RoomsJavaStep2 + + /** + * Creates a new instance of the rooms OfficesApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to Rooms REST API + * @param userAccessToken user's access token + * @return an instance of the {@link OfficesApi} + */ + protected static OfficesApi createOfficesApiClient(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new OfficesApi(apiClient); + } + + /** + * Creates a new instance of the rooms ExternalFormFillSessionsApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to Rooms REST API + * @param userAccessToken user's access token + * @return an instance of the {@link ExternalFormFillSessionsApi} + */ + protected static ExternalFormFillSessionsApi createExternalFormFillSessionsApiClient( + String basePath, + String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new ExternalFormFillSessionsApi(apiClient); + } + + /** + * Creates a new instance of the rooms RoomTemplatesApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to Rooms REST API + * @param userAccessToken user's access token + * @return an instance of the {@link RoomTemplatesApi} + */ + protected static RoomTemplatesApi createRoomTemplatesApiClient(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new RoomTemplatesApi(apiClient); + } + + /** + * Creates a new instance of the FormLibrariesApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to Rooms REST API + * @param userAccessToken user's access token + * @return an instance of the {@link RoomsApi} + */ + protected static FormLibrariesApi createFormLibrariesApi(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new FormLibrariesApi(apiClient); + } + + /** + * Creates a new instance of the FormGroupsApi. This method + * creates an instance of the ApiClient class silently. + * + * @param basePath URL to Rooms REST API + * @param userAccessToken user's access token + * @return an instance of the {@link RoomsApi} + */ + protected static FormGroupsApi createFormGroupsApi(String basePath, String userAccessToken) { + ApiClient apiClient = createApiClient(basePath, userAccessToken); + return new FormGroupsApi(apiClient); + } + + protected String getExamplePagesPath() { + return AbstractRoomsController.EXAMPLE_PAGES_PATH; + } +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/R001ControllerCreateRoom.java b/src/main/java/com/docusign/controller/rooms/examples/R001ControllerCreateRoom.java new file mode 100644 index 00000000..c364fb1b --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/R001ControllerCreateRoom.java @@ -0,0 +1,68 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.rooms.services.CreateRoomService; +import com.docusign.controller.rooms.services.GetAdminRolesService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.RoleSummary; +import com.docusign.rooms.model.Room; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * Create a room. + */ +@Controller +@RequestMapping("/r001") +public class R001ControllerCreateRoom extends AbstractRoomsController { + + @Autowired + public R001ControllerCreateRoom(DSConfiguration config, Session session, User user) { + super(config, "r001"); + this.session = session; + this.user = user; + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + + RoleSummary adminRole = GetAdminRolesService.getAdminRole( + createRolesApiClient(this.session.getBasePath(), this.user.getAccessToken()), + this.session.getAccountId()); + + // Step 2: Construct your API headers + //ds-snippet-start:Rooms1Step2 + RoomsApi roomsApi = createRoomsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + //ds-snippet-end:Rooms1Step2 + + // Step 3: Call the v2 Rooms API + //ds-snippet-start:Rooms1Step3 + Room createdRoom = CreateRoomService.createRoomFromModel( + roomsApi, + this.session.getAccountId(), + CreateRoomService.createRoomModel(adminRole.getRoleId(), args.getRoomName())); + //ds-snippet-end:Rooms1Step3 + + DoneExample.createDefault(this.title) + .withJsonObject(createdRoom) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", createdRoom.getName()) + .replaceFirst("\\{1}", createdRoom.getRoomId().toString()) + ) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/R002ControllerCreateRoomWithTemplate.java b/src/main/java/com/docusign/controller/rooms/examples/R002ControllerCreateRoomWithTemplate.java new file mode 100644 index 00000000..2887697e --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/R002ControllerCreateRoomWithTemplate.java @@ -0,0 +1,87 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.rooms.services.CreateRoomWithTemplateService; +import com.docusign.controller.rooms.services.GetAdminRolesService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.rooms.api.RoomTemplatesApi; +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.RoleSummary; +import com.docusign.rooms.model.Room; +import com.docusign.rooms.model.RoomTemplatesSummaryList; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * Create a room with template. + */ +@Controller +@RequestMapping("/r002") +public class R002ControllerCreateRoomWithTemplate extends AbstractRoomsController { + + private static final String MODEL_TEMPLATES_LIST = "templateList"; + + @Autowired + public R002ControllerCreateRoomWithTemplate(DSConfiguration config, Session session, User user) { + super(config, "r002"); + this.session = session; + this.user = user; + } + + @Override + // ***DS.snippet.0.start + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + + // Step 3: Retrieve a Rooms Template ID + //ds-snippet-start:Rooms2Step3 + RoomTemplatesApi templatesApi = createRoomTemplatesApiClient( + this.session.getBasePath(), + this.user.getAccessToken()); + RoomTemplatesSummaryList templatesSummaryList = templatesApi.getRoomTemplates(this.session.getAccountId()); + //ds-snippet-end:Rooms2Step3 + model.addAttribute(MODEL_TEMPLATES_LIST, templatesSummaryList.getRoomTemplates()); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + RoleSummary adminRole = GetAdminRolesService.getAdminRole( + createRolesApiClient(this.session.getBasePath(), this.user.getAccessToken()), + this.session.getAccountId()); + + // Step 2: Construct your API headers + //ds-snippet-start:Rooms2Step2 + RoomsApi roomsApi = createRoomsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + //ds-snippet-end:Rooms2Step2 + + // Step 4: Call the v2 Rooms API + //ds-snippet-start:Rooms2Step4 + Room createdRoom = CreateRoomWithTemplateService.createRoomFromModel( + roomsApi, + this.session.getAccountId(), + CreateRoomWithTemplateService.createRoom( + adminRole.getRoleId(), + args.getRoomName(), + args.getRoomTemplateId())); + //ds-snippet-end:Rooms2Step4 + DoneExample.createDefault(this.title) + .withJsonObject(createdRoom) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", createdRoom.getName()) + .replaceFirst("\\{1}", createdRoom.getRoomId().toString()) + ) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/R003ControllerExportingDataFromRoom.java b/src/main/java/com/docusign/controller/rooms/examples/R003ControllerExportingDataFromRoom.java new file mode 100644 index 00000000..99ec9a22 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/R003ControllerExportingDataFromRoom.java @@ -0,0 +1,71 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.rooms.services.ExportingDataFromRoomService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FieldData; +import com.docusign.rooms.model.RoomSummaryList; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + + +/** + * Exporting data from a room. + */ +@Controller +@RequestMapping("/r003") +public class R003ControllerExportingDataFromRoom extends AbstractRoomsController { + + private static final String MODEL_ROOM_LIST = "roomList"; + + @Autowired + public R003ControllerExportingDataFromRoom(DSConfiguration config, Session session, User user) { + super(config, "r003"); + this.session = session; + this.user = user; + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + RoomsApi roomsApi = createRoomsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + RoomSummaryList roomSummaryList = roomsApi.getRooms(this.session.getAccountId()); + + model.addAttribute(MODEL_ROOM_LIST, roomSummaryList.getRooms()); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + // Step 2: Construct your API headers + //ds-snippet-start:Rooms3Step2 + RoomsApi roomsApi = createRoomsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + //ds-snippet-end:Rooms3Step2 + + // Step 3: Call the v2 Rooms API + //ds-snippet-start:Rooms3Step3 + FieldData fieldData = ExportingDataFromRoomService.exportDataFromRoom( + roomsApi, + this.session.getAccountId(), + args.getRoomId()); + //ds-snippet-end:Rooms3Step3 + + DoneExample.createDefault(this.title) + .withJsonObject(fieldData) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/R004ControllerAddingFormsToRoom.java b/src/main/java/com/docusign/controller/rooms/examples/R004ControllerAddingFormsToRoom.java new file mode 100644 index 00000000..1b6bb338 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/R004ControllerAddingFormsToRoom.java @@ -0,0 +1,89 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.rooms.services.AddingFormsToRoomService; +import com.docusign.controller.rooms.services.GetFormSummaryListService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.api.RoomsApi.GetRoomsOptions; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FormSummary; +import com.docusign.rooms.model.RoomDocument; +import com.docusign.rooms.model.RoomSummaryList; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.util.List; + + +/** + * Adding forms to a room. + */ +@Controller +@RequestMapping("/r004") +public class R004ControllerAddingFormsToRoom extends AbstractRoomsController { + + private static final String MODEL_FORM_LIST = "formList"; + + private static final String MODEL_ROOM_LIST = "roomList"; + + @Autowired + public R004ControllerAddingFormsToRoom(DSConfiguration config, Session session, User user) { + super(config, "r004"); + this.session = session; + this.user = user; + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + RoomsApi roomsApi = createRoomsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + + // Step 3. Obtain the desired form ID + //ds-snippet-start:Rooms4Step3 + GetRoomsOptions gro = roomsApi.new GetRoomsOptions(); + gro.setCount(5); + RoomSummaryList roomSummaryList = roomsApi.getRooms(this.session.getAccountId(), gro); + + List forms = GetFormSummaryListService.getFormSummaryList( + createFormLibrariesApi(session.getBasePath(), this.user.getAccessToken()), + this.session.getAccountId()); + + //ds-snippet-end:Rooms4Step3 + model.addAttribute(MODEL_ROOM_LIST, roomSummaryList.getRooms()); + model.addAttribute(MODEL_FORM_LIST, forms); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + // Step 2. Construct your API headers + //ds-snippet-start:Rooms4Step2 + RoomsApi roomsApi = createRoomsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + //ds-snippet-end:Rooms4Step2 + + // Step 4. Call the v2 Rooms API + //ds-snippet-start:Rooms4Step4 + RoomDocument roomDocument = AddingFormsToRoomService.addFormsToRoom( + roomsApi, + this.session.getAccountId(), + args.getFormId(), + args.getRoomId()); + //ds-snippet-end:Rooms4Step4 + + DoneExample.createDefault(this.title) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .withJsonObject(roomDocument) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/R005ControllerGetRoomsWithFilters.java b/src/main/java/com/docusign/controller/rooms/examples/R005ControllerGetRoomsWithFilters.java new file mode 100644 index 00000000..35331294 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/R005ControllerGetRoomsWithFilters.java @@ -0,0 +1,81 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.rooms.services.GetRoomsWithFiltersService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.core.utils.DateUtils; +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.RoomSummaryList; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.time.LocalDateTime; + +/** + * Get Rooms with filters. + */ +@Controller +@RequestMapping("/r005") +public class R005ControllerGetRoomsWithFilters extends AbstractRoomsController { + + private static final String MODEL_START_DATE = "startDate"; + + private static final String MODEL_END_DATE = "endDate"; + + private static final int FROM_DATE_OFFSET_DAYS = 10; + + private static final int FROM_DATE_FORWARD_DAYS = 1; + + @Autowired + public R005ControllerGetRoomsWithFilters(DSConfiguration config, Session session, User user) { + super(config, "r005"); + this.session = session; + this.user = user; + } + + @Override + // ***DS.snippet.0.start + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + + LocalDateTime current = LocalDateTime.now().plusDays(FROM_DATE_FORWARD_DAYS); + LocalDateTime past = LocalDateTime.now().minusDays(FROM_DATE_OFFSET_DAYS); + + model.addAttribute(MODEL_START_DATE, DateUtils.DATE_WITH_LINES.format(past)); + model.addAttribute(MODEL_END_DATE, DateUtils.DATE_WITH_LINES.format(current)); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + // Step 2: Construct your API headers + //ds-snippet-start:Rooms5Step2 + RoomsApi roomsApi = createRoomsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + //ds-snippet-end:Rooms5Step2 + + // Step 4. Call the v2 Rooms API + //ds-snippet-start:Rooms5Step4 + RoomSummaryList rooms = GetRoomsWithFiltersService.getRoomsWithFilters( + roomsApi, + this.session.getAccountId(), + args.getStartDate(), + args.getEndDate()); + //ds-snippet-end:Rooms5Step4 + + DoneExample.createDefault(this.title) + .withJsonObject(rooms) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/R006ControllerCreateExternalFormFillSession.java b/src/main/java/com/docusign/controller/rooms/examples/R006ControllerCreateExternalFormFillSession.java new file mode 100644 index 00000000..833afae0 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/R006ControllerCreateExternalFormFillSession.java @@ -0,0 +1,88 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.rooms.services.ExternalFormSessionService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.rooms.api.ExternalFormFillSessionsApi; +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.ExternalFormFillSession; +import com.docusign.rooms.model.ExternalFormFillSessionForCreate; +import com.docusign.rooms.model.RoomDocumentList; +import com.docusign.rooms.model.RoomSummaryList; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * Creating an external form fill session. + */ +@Controller +@RequestMapping("/r006") +public class R006ControllerCreateExternalFormFillSession extends AbstractRoomsController { + + private static final String MODEL_ROOMS_LIST = "roomsList"; + + private static final String MODEL_DOCUMENTS_LIST = "documentsList"; + + @Autowired + public R006ControllerCreateExternalFormFillSession(DSConfiguration config, Session session, User user) { + super(config, "r006"); + this.session = session; + this.user = user; + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + + RoomsApi roomsApi = createRoomsApiClient(this.session.getBasePath(), this.user.getAccessToken()); + RoomSummaryList rooms = (new ExternalFormSessionService()).getRooms(roomsApi, this.session.getAccountId()); + + Integer roomsId = args.getRoomId(); + + if (roomsId != null) { + RoomDocumentList documents = (new ExternalFormSessionService()).getDocuments(roomsApi, this.session.getAccountId(), roomsId); + model.addAttribute(MODEL_DOCUMENTS_LIST, documents.getDocuments()); + } + + model.addAttribute(MODEL_ROOMS_LIST, rooms.getRooms()); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + ExternalFormFillSessionsApi externalFormFillSessionsApi = createExternalFormFillSessionsApiClient( + this.session.getBasePath(), this.user.getAccessToken()); + + //ds-snippet-start:Rooms6Step3 + ExternalFormFillSessionForCreate sessionToCreate = new ExternalFormFillSessionForCreate(); + sessionToCreate.setRoomId(args.getRoomId()); + sessionToCreate.setFormId(args.getDocumentId()); + sessionToCreate.setXFrameAllowedUrl("http://localhost:8080"); + //ds-snippet-end:Rooms6Step3 + + //ds-snippet-start:Rooms6Step4 + ExternalFormFillSession formFillSession = (new ExternalFormSessionService()).createSession( + externalFormFillSessionsApi, + this.session.getAccountId(), + sessionToCreate); + //ds-snippet-end:Rooms6Step4 + //ds-snippet-start:Rooms6Step5 + DoneExample.createDefault(this.title) + .withMessage(getTextForCodeExample().ResultsPageText) + .withJsonObject(formFillSession) + .withFormFill(formFillSession.getUrl()) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + //ds-snippet-end:Rooms6Step5 + } + // ***DS.snippet.0.end +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/R007ControllerCreateFormGroup.java b/src/main/java/com/docusign/controller/rooms/examples/R007ControllerCreateFormGroup.java new file mode 100644 index 00000000..fb6421ee --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/R007ControllerCreateFormGroup.java @@ -0,0 +1,57 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.rooms.services.CreateFormGroupService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.rooms.api.FormGroupsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FormGroup; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * Creating create a form group. + */ +@Controller +@RequestMapping("/r007") +public class R007ControllerCreateFormGroup extends AbstractRoomsController { + + @Autowired + public R007ControllerCreateFormGroup(DSConfiguration config, Session session, User user) { + super(config, "r007"); + this.session = session; + this.user = user; + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + + //ds-snippet-start:Rooms7Step2 + FormGroupsApi formGroupsApi = createFormGroupsApi( + this.session.getBasePath(), this.user.getAccessToken() + ); + //ds-snippet-end:Rooms7Step2 + + FormGroup formGroup = CreateFormGroupService.createFormGroup( + formGroupsApi, + this.session.getAccountId(), + args.getFormGroupName()); + + DoneExample.createDefault(this.title) + .withJsonObject(formGroup) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", formGroup.getName())) + .addToModel(model, config); + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/R008ControllerGrantOfficeAccessToFormGroup.java b/src/main/java/com/docusign/controller/rooms/examples/R008ControllerGrantOfficeAccessToFormGroup.java new file mode 100644 index 00000000..689bc6c3 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/R008ControllerGrantOfficeAccessToFormGroup.java @@ -0,0 +1,96 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.rooms.services.GrantOfficeAccessToFormGroupService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.rooms.api.FormGroupsApi; +import com.docusign.rooms.api.OfficesApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FormGroupSummaryList; +import com.docusign.rooms.model.OfficeSummaryList; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +/** + * Granting office access to a form group. + */ +@Controller +@RequestMapping("/r008") +public class R008ControllerGrantOfficeAccessToFormGroup extends AbstractRoomsController { + + private static final String MODEL_OFFICE_LIST = "officeList"; + + private static final String MODEL_FORM_GROUP_LIST = "formGroupList"; + + private static final String OFFICE_ALREADY_HAS_ACCESS_TO_FORM_GROUP_ERROR_MESSAGE = "OFFICE_ALREADY_HAS_ACCESS_TO_FORM_GROUP"; + + private FormGroupsApi formGroupsApi; + + @Autowired + public R008ControllerGrantOfficeAccessToFormGroup(DSConfiguration config, Session session, User user) { + super(config, "r008"); + this.session = session; + this.user = user; + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + + //ds-snippet-start:Rooms8Step2 + this.formGroupsApi = createFormGroupsApi( + this.session.getBasePath(), this.user.getAccessToken() + ); + //ds-snippet-end:Rooms8Step2 + + //ds-snippet-start:Rooms8Step3 + OfficesApi officesApi = createOfficesApiClient(this.session.getBasePath(), this.user.getAccessToken()); + OfficeSummaryList officeSummaryList = officesApi.getOffices(this.session.getAccountId()); + //ds-snippet-end:Rooms8Step3 + + //ds-snippet-start:Rooms8Step4 + FormGroupSummaryList formGroupSummaryList = formGroupsApi.getFormGroups(this.session.getAccountId()); + //ds-snippet-end:Rooms8Step4 + + model.addAttribute(MODEL_FORM_GROUP_LIST, formGroupSummaryList.getFormGroups()); + model.addAttribute(MODEL_OFFICE_LIST, officeSummaryList.getOfficeSummaries()); + } + + @Override + // ***DS.snippet.0.start + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + + try { + //ds-snippet-start:Rooms8Step5 + GrantOfficeAccessToFormGroupService.grantOfficeAccessToFormGroup( + this.formGroupsApi, + this.session.getAccountId(), + args.getFormGroupId(), + args.getOfficeId()); + //ds-snippet-end:Rooms8Step5 + + DoneExample.createDefault(this.title) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", String.valueOf(args.getOfficeId())) + .replaceFirst("\\{1}", String.valueOf(args.getFormGroupId()))) + .addToModel(model, config); + } catch (ApiException apiException) { + if (!apiException.getMessage().contains(OFFICE_ALREADY_HAS_ACCESS_TO_FORM_GROUP_ERROR_MESSAGE)) { + throw apiException; + } + DoneExample.createDefault(this.title) + .withMessage("The selected office already has access to a form group!") + .addToModel(model, config); + } + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/rooms/examples/R009ControllerAssignFormToFormGroup.java b/src/main/java/com/docusign/controller/rooms/examples/R009ControllerAssignFormToFormGroup.java new file mode 100644 index 00000000..12f30abe --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/examples/R009ControllerAssignFormToFormGroup.java @@ -0,0 +1,100 @@ +package com.docusign.controller.rooms.examples; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.controller.rooms.services.AssignFormToFormGroupService; +import com.docusign.controller.rooms.services.GetFormSummaryListService; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.rooms.api.FormGroupsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FormGroupFormToAssign; +import com.docusign.rooms.model.FormGroupSummaryList; +import com.docusign.rooms.model.FormSummary; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.RequestMapping; + +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.util.List; + +/** + * Assigning a form to a form group. + */ +@Controller +@RequestMapping("/r009") +public class R009ControllerAssignFormToFormGroup extends AbstractRoomsController { + + private static final String MODEL_FORM_LIST = "formList"; + + private static final String MODEL_FORM_GROUP_LIST = "formGroupList"; + + private static final String FORM_ALREADY_EXISTS_ERROR_MESSAGE = "Form in the form group already exists"; + + private FormGroupsApi formGroupsApi; + + @Autowired + public R009ControllerAssignFormToFormGroup(DSConfiguration config, Session session, User user) { + super(config, "r009"); + this.session = session; + this.user = user; + } + + @Override + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + super.onInitModel(args, model); + + //ds-snippet-start:Rooms9Step4 + this.formGroupsApi = createFormGroupsApi( + this.session.getBasePath(), this.user.getAccessToken() + ); + FormGroupSummaryList formGroupSummaryList = formGroupsApi.getFormGroups(this.session.getAccountId()); + //ds-snippet-end:Rooms9Step4 + + //ds-snippet-start:Rooms9Step3 + List forms = GetFormSummaryListService.getFormSummaryList( + createFormLibrariesApi(session.getBasePath(), this.user.getAccessToken()), + this.session.getAccountId()); + //ds-snippet-end:Rooms9Step3 + + model.addAttribute(MODEL_FORM_GROUP_LIST, formGroupSummaryList.getFormGroups()); + model.addAttribute(MODEL_FORM_LIST, forms); + } + + @Override + protected Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws IOException, ApiException { + try { + //ds-snippet-start:Rooms9Step6 + FormGroupFormToAssign formGroupFormToAssign = AssignFormToFormGroupService.assignFormToFormGroup( + this.formGroupsApi, + this.session.getAccountId(), + args.getFormId(), + args.getFormGroupId()); + //ds-snippet-end:Rooms9Step6 + + DoneExample.createDefault(this.title) + .withJsonObject(formGroupFormToAssign) + .withMessage(getTextForCodeExampleByApiType().ResultsPageText + .replaceFirst("\\{0}", String.valueOf(args.getOfficeId())) + .replaceFirst("\\{1}", String.valueOf(args.getFormGroupId()))) + .addToModel(model, config); + } catch (ApiException apiException) { + if (apiException.getMessage().contains(FORM_ALREADY_EXISTS_ERROR_MESSAGE)) { + DoneExample.createDefault(this.title) + .withMessage(FORM_ALREADY_EXISTS_ERROR_MESSAGE) + .addToModel(model, config); + } else if (apiException.getMessage().contains(getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessageCheck)) { + DoneExample.createDefault(this.title) + .withMessage(getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessage) + .addToModel(model, config); + } + + throw apiException; + } + return DONE_EXAMPLE_PAGE; + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/AddingFormsToRoomService.java b/src/main/java/com/docusign/controller/rooms/services/AddingFormsToRoomService.java new file mode 100644 index 00000000..25fe945d --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/AddingFormsToRoomService.java @@ -0,0 +1,20 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FormForAdd; +import com.docusign.rooms.model.RoomDocument; + +import java.util.UUID; + +public final class AddingFormsToRoomService { + public static RoomDocument addFormsToRoom( + RoomsApi roomsApi, + String accountId, + UUID formId, + Integer roomId + ) throws ApiException { + FormForAdd formForAdd = new FormForAdd().formId(formId); + return roomsApi.addFormToRoom(accountId, roomId, formForAdd); + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/AssignFormToFormGroupService.java b/src/main/java/com/docusign/controller/rooms/services/AssignFormToFormGroupService.java new file mode 100644 index 00000000..226f517e --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/AssignFormToFormGroupService.java @@ -0,0 +1,25 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.FormGroupsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FormGroupFormToAssign; + +import java.util.UUID; + +public final class AssignFormToFormGroupService { + public static FormGroupFormToAssign assignFormToFormGroup( + FormGroupsApi formGroupsApi, + String accountId, + UUID formId, + UUID formGroupId + ) throws ApiException { + //ds-snippet-start:Rooms9Step5 + FormGroupFormToAssign formGroupFormToAssignRequest = new FormGroupFormToAssign() + .formId(formId); + //ds-snippet-end:Rooms9Step5 + + return formGroupsApi.assignFormGroupForm( + accountId, formGroupId, formGroupFormToAssignRequest); + + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/CreateFormGroupService.java b/src/main/java/com/docusign/controller/rooms/services/CreateFormGroupService.java new file mode 100644 index 00000000..df0a32d0 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/CreateFormGroupService.java @@ -0,0 +1,23 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.FormGroupsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FormGroup; +import com.docusign.rooms.model.FormGroupForCreate; + +public final class CreateFormGroupService { + public static FormGroup createFormGroup( + FormGroupsApi formGroupsApi, + String accountId, + String formGroupName + ) throws ApiException { + //ds-snippet-start:Rooms7Step3 + FormGroupForCreate formGroupForCreate = new FormGroupForCreate() + .name(formGroupName); + //ds-snippet-end:Rooms7Step3 + + //ds-snippet-start:Rooms7Step4 + return formGroupsApi.createFormGroup(accountId, formGroupForCreate); + //ds-snippet-end:Rooms7Step4 + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/CreateRoomService.java b/src/main/java/com/docusign/controller/rooms/services/CreateRoomService.java new file mode 100644 index 00000000..5b0130c7 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/CreateRoomService.java @@ -0,0 +1,38 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FieldDataForCreate; +import com.docusign.rooms.model.Room; +import com.docusign.rooms.model.RoomForCreate; + +//ds-snippet-start:Rooms1Step4 +public final class CreateRoomService { + public static Room createRoomFromModel( + RoomsApi roomsApi, + String accountId, + RoomForCreate roomForCreate + ) throws ApiException { + return roomsApi.createRoom(accountId, roomForCreate); + } +//ds-snippet-end:Rooms1Step4 + + public static RoomForCreate createRoomModel(Integer roleId, String roomName) { + return new RoomForCreate() + .name(roomName) + .roleId(roleId) + .transactionSideId("listbuy") + .fieldData( + new FieldDataForCreate() + .putDataItem("address1", "123 EZ Street") + .putDataItem("address2", "unit 10") + .putDataItem("city", "Galaxian") + .putDataItem("state", "US-HI") + .putDataItem("postalCode", "11112") + .putDataItem("companyRoomStatus", "5") + .putDataItem( + "comments", + "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.") + ); + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/CreateRoomWithTemplateService.java b/src/main/java/com/docusign/controller/rooms/services/CreateRoomWithTemplateService.java new file mode 100644 index 00000000..caf8345f --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/CreateRoomWithTemplateService.java @@ -0,0 +1,36 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FieldDataForCreate; +import com.docusign.rooms.model.Room; +import com.docusign.rooms.model.RoomForCreate; + +public final class CreateRoomWithTemplateService { + public static Room createRoomFromModel( + RoomsApi roomsApi, + String accountId, + RoomForCreate roomForCreate + ) throws ApiException { + return roomsApi.createRoom(accountId, roomForCreate); + } + + public static RoomForCreate createRoom(Integer roleId, String roomName, Integer templateId) { + //ds-snippet-start:Rooms2Step5 + return new RoomForCreate() + .name(roomName) + .roleId(roleId) + .templateId(templateId) + .fieldData( + new FieldDataForCreate() + .putDataItem("address1", "123 EZ Street") + .putDataItem("address2", "unit 10") + .putDataItem("city", "Galaxian") + .putDataItem("state", "US-HI") + .putDataItem("postalCode", "11112") + .putDataItem("companyRoomStatus", "5") + .putDataItem("comments", "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.") + ); + //ds-snippet-end:Rooms2Step5 + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/ExportingDataFromRoomService.java b/src/main/java/com/docusign/controller/rooms/services/ExportingDataFromRoomService.java new file mode 100644 index 00000000..2be2fde5 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/ExportingDataFromRoomService.java @@ -0,0 +1,15 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FieldData; + +public final class ExportingDataFromRoomService { + public static FieldData exportDataFromRoom( + RoomsApi roomsApi, + String accountId, + Integer roomId + ) throws ApiException { + return roomsApi.getRoomFieldData(accountId, roomId); + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/ExternalFormSessionService.java b/src/main/java/com/docusign/controller/rooms/services/ExternalFormSessionService.java new file mode 100644 index 00000000..4f6070e1 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/ExternalFormSessionService.java @@ -0,0 +1,36 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.ExternalFormFillSessionsApi; +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.ExternalFormFillSession; +import com.docusign.rooms.model.ExternalFormFillSessionForCreate; +import com.docusign.rooms.model.RoomDocumentList; +import com.docusign.rooms.model.RoomSummaryList; + +public class ExternalFormSessionService { + public RoomDocumentList getDocuments( + RoomsApi roomsApi, + String accountId, + Integer roomId + ) throws ApiException { + return roomsApi.getDocuments( + accountId, + roomId); + } + + public RoomSummaryList getRooms( + RoomsApi roomsApi, + String accountId + ) throws ApiException { + return roomsApi.getRooms(accountId); + } + + public ExternalFormFillSession createSession( + ExternalFormFillSessionsApi externalFormFillSessionsApi, + String accountId, + ExternalFormFillSessionForCreate sessionForCreate + ) throws ApiException { + return externalFormFillSessionsApi.createExternalFormFillSession(accountId, sessionForCreate); + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/GetAdminRolesService.java b/src/main/java/com/docusign/controller/rooms/services/GetAdminRolesService.java new file mode 100644 index 00000000..ec79082f --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/GetAdminRolesService.java @@ -0,0 +1,18 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.RolesApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.RoleSummary; +import com.docusign.rooms.model.RoleSummaryList; + +public final class GetAdminRolesService { + public static RoleSummary getAdminRole(RolesApi rolesApi, String accountId) + throws ApiException { + RoleSummaryList roleSummaryList = rolesApi.getRoles(accountId); + return roleSummaryList.getRoles() + .stream() + .filter(RoleSummary::isIsDefaultForAdmin) + .findFirst() + .get(); + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/GetFormSummaryListService.java b/src/main/java/com/docusign/controller/rooms/services/GetFormSummaryListService.java new file mode 100644 index 00000000..4e8bb230 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/GetFormSummaryListService.java @@ -0,0 +1,38 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.FormLibrariesApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.FormLibrarySummary; +import com.docusign.rooms.model.FormLibrarySummaryList; +import com.docusign.rooms.model.FormSummary; +import com.docusign.rooms.model.FormSummaryList; + +import java.util.ArrayList; +import java.util.List; + + +public final class GetFormSummaryListService { + public static List getFormSummaryList( + FormLibrariesApi formLibrariesApi, + String accountId + ) throws ApiException { + FormLibrarySummaryList formLibrarySummaryList = formLibrariesApi.getFormLibraries(accountId); + + List forms = new ArrayList<>(); + int counter = 0; // Counter variable + + for (FormLibrarySummary formLibrarySummary : formLibrarySummaryList.getFormsLibrarySummaries()) { + FormSummaryList formSummaryList = formLibrariesApi.getFormLibraryForms( + accountId, + formLibrarySummary.getFormsLibraryId()); + forms.addAll(formSummaryList.getForms()); + counter += formSummaryList.getForms().size(); + + if (counter >= 3) { + break; + } + } + + return forms; + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/GetRoomsWithFiltersService.java b/src/main/java/com/docusign/controller/rooms/services/GetRoomsWithFiltersService.java new file mode 100644 index 00000000..c3a5f0a3 --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/GetRoomsWithFiltersService.java @@ -0,0 +1,24 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.RoomsApi; +import com.docusign.rooms.client.ApiException; +import com.docusign.rooms.model.RoomSummaryList; + +public final class GetRoomsWithFiltersService { + public static RoomSummaryList getRoomsWithFilters( + RoomsApi roomsApi, + String accountId, + String startDate, + String endDate + ) throws ApiException { + // Step 3. Prepare your request parameters + //ds-snippet-start:Rooms5Step3 + RoomsApi.GetRoomsOptions options = roomsApi.new GetRoomsOptions(); + options.setFieldDataChangedStartDate(startDate); + options.setFieldDataChangedEndDate(endDate); + //ds-snippet-end:Rooms5Step3 + + //Call the v2 Rooms API + return roomsApi.getRooms(accountId, options); + } +} diff --git a/src/main/java/com/docusign/controller/rooms/services/GrantOfficeAccessToFormGroupService.java b/src/main/java/com/docusign/controller/rooms/services/GrantOfficeAccessToFormGroupService.java new file mode 100644 index 00000000..61b48dbf --- /dev/null +++ b/src/main/java/com/docusign/controller/rooms/services/GrantOfficeAccessToFormGroupService.java @@ -0,0 +1,20 @@ +package com.docusign.controller.rooms.services; + +import com.docusign.rooms.api.FormGroupsApi; +import com.docusign.rooms.client.ApiException; + +import java.util.UUID; + +public final class GrantOfficeAccessToFormGroupService { + public static void grantOfficeAccessToFormGroup( + FormGroupsApi formGroupsApi, + String accountId, + UUID formGroupId, + Integer officeId + ) throws ApiException { + formGroupsApi.grantOfficeAccessToFormGroup( + accountId, + formGroupId, + officeId); + } +} diff --git a/src/main/java/com/docusign/common/DiffField.java b/src/main/java/com/docusign/core/common/DiffField.java similarity index 92% rename from src/main/java/com/docusign/common/DiffField.java rename to src/main/java/com/docusign/core/common/DiffField.java index 19ae5588..bf290006 100644 --- a/src/main/java/com/docusign/common/DiffField.java +++ b/src/main/java/com/docusign/core/common/DiffField.java @@ -1,11 +1,10 @@ -package com.docusign.common; - -import java.lang.reflect.Field; -import java.util.Locale; +package com.docusign.core.common; +import lombok.Value; import org.apache.commons.lang3.StringUtils; -import lombok.Value; +import java.lang.reflect.Field; +import java.util.Locale; /** @@ -17,13 +16,16 @@ public class DiffField { private String name; + private String leftValue; + private String rightValue; /** * Creates an instance of the DiffField by a {@link Field} and two objects. + * * @param field the object which provides information about a single field of a class - * @param left the first comparing object, can be null + * @param left the first comparing object, can be null * @param right the second comparing object, can be null * @return created object containing field name and string representation of values * @throws IllegalAccessException when an application tries to reflectively get a field @@ -36,8 +38,9 @@ public static DiffField create(Field field, Object left, Object right) throws Il /** * Creates an instance of the DiffField by {@link Field} and two objects. * Field name is formatted to better readability. + * * @param field the object which provides information about a single field of a class - * @param left the first comparing object, can be null + * @param left the first comparing object, can be null * @param right the second comparing object, can be null * @return created object containing field name and string representation of values * @throws IllegalAccessException when an application tries to reflectively get a field @@ -52,6 +55,7 @@ public static DiffField createWithFormattedName(Field field, Object left, Object * Convert a member name represented as string in a Camel style for better * readability. E.g. name 'permissionProfileName' will be transformed to * "permission profile name" string. + * * @param name the name of the field * @return formatted name */ diff --git a/src/main/java/com/docusign/common/DocumentType.java b/src/main/java/com/docusign/core/common/DocumentType.java similarity index 90% rename from src/main/java/com/docusign/common/DocumentType.java rename to src/main/java/com/docusign/core/common/DocumentType.java index 9d099802..1a59d912 100644 --- a/src/main/java/com/docusign/common/DocumentType.java +++ b/src/main/java/com/docusign/core/common/DocumentType.java @@ -1,6 +1,6 @@ -package com.docusign.common; +package com.docusign.core.common; -import javax.ws.rs.core.MediaType; +import jakarta.ws.rs.core.MediaType; /** * This enumeration represents supported document types for signing. @@ -11,6 +11,7 @@ public enum DocumentType { PDF("pdf", "application/pdf"); private final String defaultFileExtention; + private final String mime; DocumentType(String defaultFileExtention, String mime) { diff --git a/src/main/java/com/docusign/common/Languages.java b/src/main/java/com/docusign/core/common/Languages.java similarity index 97% rename from src/main/java/com/docusign/common/Languages.java rename to src/main/java/com/docusign/core/common/Languages.java index e7dea874..5607d140 100644 --- a/src/main/java/com/docusign/common/Languages.java +++ b/src/main/java/com/docusign/core/common/Languages.java @@ -1,9 +1,10 @@ -package com.docusign.common; +package com.docusign.core.common; + +import lombok.Value; import java.util.ArrayList; import java.util.Collections; import java.util.List; -import lombok.Value; /** @@ -13,8 +14,8 @@ public final class Languages { private static final List SUPPORTED_LANGUAGES = createList(); - private Languages() {} - + private Languages() { + } public static List getSupportedLanguages() { return Collections.unmodifiableList(SUPPORTED_LANGUAGES); @@ -72,6 +73,8 @@ private static List createList() { @Value public static class Lang { private String code; + private String name; + } } diff --git a/src/main/java/com/docusign/common/Utils.java b/src/main/java/com/docusign/core/common/Utils.java similarity index 68% rename from src/main/java/com/docusign/common/Utils.java rename to src/main/java/com/docusign/core/common/Utils.java index dd9fe265..a1fbb11b 100644 --- a/src/main/java/com/docusign/common/Utils.java +++ b/src/main/java/com/docusign/core/common/Utils.java @@ -1,4 +1,11 @@ -package com.docusign.common; +package com.docusign.core.common; + +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.model.AccountInformation; +import org.apache.commons.codec.binary.StringUtils; +import org.apache.commons.lang3.ObjectUtils; +import org.springframework.http.HttpHeaders; import java.lang.reflect.Field; import java.lang.reflect.Modifier; @@ -6,25 +13,24 @@ import java.util.List; import java.util.stream.Collectors; -import org.apache.commons.codec.binary.StringUtils; -import org.apache.commons.lang3.ObjectUtils; - public final class Utils { - private Utils() {} + private Utils() { + } /** * Examines member values of simple Java objects. All values will be * represented as string. This functions creates a list of all non static * field values. One of the comparing object can be equal null * but not both. - * @param left the first comparing object - * @param right the second comparing object + * + * @param left the first comparing object + * @param right the second comparing object * @param formatName whether format member names * @return list of {@link DiffField} objects * @throws IllegalArgumentException if both of comparable objects is - * null or if objects belong to different classes + * null or if objects belong to different classes */ public static List compareFields(Object left, Object right, boolean formatName) { if (left == null && right == null) { @@ -60,12 +66,13 @@ public static List compareFields(Object left, Object right, boolean f * be represented as string. This functions creates a list of all non * static field values. One of the comparing object can be equal * null but not both. - * @param left the first comparing object - * @param right the second comparing object + * + * @param left the first comparing object + * @param right the second comparing object * @param formatName whether format member names * @return list of {@link DiffField} objects * @throws IllegalArgumentException if both of comparable objects is - * null or if objects belong to different classes + * null or if objects belong to different classes */ public static List findDifferentFields(Object left, Object right, boolean formatName) { return compareFields(left, right, formatName) @@ -73,4 +80,18 @@ public static List findDifferentFields(Object left, Object right, boo .filter(field -> !StringUtils.equals(field.getLeftValue(), field.getRightValue())) .collect(Collectors.toList()); } + + public static Boolean isCfr(String basePath, String accessToken, String accountId) throws Exception { + if (accessToken == null) { + + } + ApiClient apiClient = new ApiClient(basePath); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken); + AccountsApi accountsApi = new AccountsApi(apiClient); + + AccountInformation accountInfo = accountsApi.getAccountInformation(accountId); + String isEnabled = accountInfo.getStatus21CFRPart11(); + + return isEnabled != null && isEnabled.equals("enabled"); + } } diff --git a/src/main/java/com/docusign/core/controller/AbstractController.java b/src/main/java/com/docusign/core/controller/AbstractController.java new file mode 100644 index 00000000..1c4b25cf --- /dev/null +++ b/src/main/java/com/docusign/core/controller/AbstractController.java @@ -0,0 +1,258 @@ +package com.docusign.core.controller; + +import com.docusign.DSConfiguration; +import com.docusign.common.WorkArguments; +import com.docusign.core.model.ApiType; +import com.docusign.core.model.AuthType; +import com.docusign.core.model.DoneExample; +import com.docusign.core.model.Session; +import com.docusign.core.model.manifestModels.CodeExampleText; +import com.docusign.core.model.manifestModels.ManifestGroup; +import com.docusign.esign.client.auth.OAuth; +import org.apache.commons.lang3.exception.ExceptionUtils; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.security.core.Authentication; +import org.springframework.security.core.context.SecurityContextHolder; +import org.springframework.security.oauth2.client.OAuth2AuthorizedClient; +import org.springframework.security.oauth2.client.OAuth2AuthorizedClientService; +import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken; +import org.springframework.security.oauth2.core.OAuth2AccessToken; +import org.springframework.security.oauth2.core.user.OAuth2User; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PostMapping; + +import javax.servlet.http.HttpServletResponse; +import java.time.Instant; +import java.util.List; +import java.util.Objects; + + +/** + * Abstract base class for all controllers. It handles all requests which are + * registered by the derived classes and delegates an example specific action + * back to the appropriate controllers. If a user had not been authorized, it + * redirects him onto an authentication page. Derived classes must override an + * abstract method {@link #doWork(WorkArguments, ModelMap, HttpServletResponse)} + * to do something. This method is called from the POST request. Optionally you + * can override method {@link #onInitModel(WorkArguments, ModelMap)} to add + * example specific attributes into a page. + */ +@Controller +public abstract class AbstractController { + + protected static final String BEARER_AUTHENTICATION = "Bearer "; + + protected static final String DONE_EXAMPLE_PAGE = "pages/example_done"; + + protected static final String DONE_EXAMPLE_PAGE_COMPARE = "pages/example_done_compare"; + + protected static final String EXAMPLE_PENDING_PAGE = "pages/example_pending"; + + protected static final String ERROR_PAGE = "error"; + + protected static final String LAUNCHER_TEXTS = "launcherTexts"; + + private static final String REDIRECT_PREFIX = "redirect:"; + + protected static final String REDIRECT_AUTHENTICATION_PAGE = REDIRECT_PREFIX + "/ds/mustAuthenticate"; + + protected static final String REDIRECT_CFR_QUICKSTART = REDIRECT_PREFIX + "/eg041"; + + private static final String EXAMPLE_TEXT = "example"; + + protected final String exampleName; + + protected final DSConfiguration config; + + private final String pagePath; + + @Autowired + protected Session session; + + protected String title; + + @Autowired + private OAuth2AuthorizedClientService authorizedClientService; + + private CodeExampleText codeExampleText; + + public AbstractController(DSConfiguration config, String exampleName) { + this.config = config; + this.exampleName = exampleName; + this.pagePath = this.getExamplePagesPath() + exampleName; + } + + public CodeExampleText getTextForCodeExampleByApiType() { + ApiType apiType = ApiType.giveTypeByName(this.exampleName); + if (codeExampleText != null) { + return codeExampleText; + } + + config.setSelectedApiType(apiType.toString()); + codeExampleText = getTextForCodeExample(); + + return codeExampleText; + } + + protected abstract String getExamplePagesPath(); + + @GetMapping + public String get(WorkArguments args, ModelMap model) { + if (ApiType.giveTypeByName(this.exampleName) != ApiType.CONNECT && isTokenExpired()) { + return REDIRECT_AUTHENTICATION_PAGE; + } + + if(ApiType.giveTypeByName(this.exampleName) == ApiType.MONITOR && session.getAuthTypeSelected() != AuthType.JWT){ + session.setMonitorExampleRedirect("/" + this.exampleName); + return REDIRECT_AUTHENTICATION_PAGE; + } + + try { + onInitModel(args, model); + return pagePath; + } catch (Exception exception) { + if (config.getQuickstart().equals("true") && exception.getMessage() == config.getCodeExamplesText().getSupportingTexts().getCFRError()) { + config.setQuickstart("false"); + return handleRedirectToCfr(model); + } else { + return handleException(exception, model); + } + } + } + + @PostMapping + public Object create(WorkArguments args, ModelMap model, HttpServletResponse response) { + if (ApiType.giveTypeByName(this.exampleName) != ApiType.CONNECT && isTokenExpired()) { + return REDIRECT_AUTHENTICATION_PAGE; + } + + try { + return doWork(args, model, response); + } catch (Exception exception) { + return handleException(exception, model); + } + } + + /** + * This method is called from the GET request and it should initialize a + * model. Override this method if it is necessary to add example specific + * attributes into the model. + * + * @param args the session attributes + * @param model the model data + */ + protected void onInitModel(WorkArguments args, ModelMap model) throws Exception { + this.title = getTextForCodeExampleByApiType().ExampleName; + + this.setTheCurrentApiTypeAndBaseUrl(); + Class clazz = Objects.requireNonNullElse(getClass().getEnclosingClass(), getClass()); + String srcPath = String.join("", config.getExampleUrl(), clazz.getName().replace('.', '/'), ".java"); + String viewSourceFile = config.getCodeExamplesText().SupportingTexts + .getViewSourceFile().replaceFirst( + "\\{0}", + "" + clazz.getSimpleName() + ".java" + "" + ); + model.addAttribute("csrfToken", ""); + model.addAttribute("title", title); + model.addAttribute("viewSourceFile", viewSourceFile); + model.addAttribute("documentation", config.getDocumentationPath() + exampleName); + model.addAttribute(EXAMPLE_TEXT, getTextForCodeExampleByApiType()); + model.addAttribute(LAUNCHER_TEXTS, config.getCodeExamplesText().SupportingTexts); + } + + public void setTheCurrentApiTypeAndBaseUrl() { + config.setSelectedApiType(ApiType.giveTypeByName(this.exampleName).toString()); + String basePath = session.getOauthAccount() != null ? + this.config.getBaseUrl(config.getSelectedApiIndex(), session.getOauthAccount()) + config.getSelectedApiIndex().getBaseUrlSuffix() + : null; + session.setBasePath(basePath); + } + + /** + * This method is called from the POST request. Example pages must override + * it. Overridden method should return an Object means URL to redirect. + * + * @param args the work arguments got from the current page + * @param model page model holder + * @param response for HTTP-specific functionality in sending a response + * @return {@link Object}. Possible types and values: null, + * {@link String} representation of the URL or Spring RedirectView object, + * (see {@link org.springframework.web.servlet.view.RedirectView RedirectView}) + * @throws Exception if calling API has failed or if I/O operation has failed + */ + protected abstract Object doWork(WorkArguments args, ModelMap model, + HttpServletResponse response) throws Exception; + + private String handleException(Exception exception, ModelMap model) { + model.addAttribute(LAUNCHER_TEXTS, config.getCodeExamplesText().SupportingTexts); + String stackTrace = ExceptionUtils.getStackTrace(exception); + String exceptionMessage = ""; + String fixingInstructions = ""; + + if (exception != null) { + exceptionMessage = exception.getMessage(); + if (model.getAttribute("caseForInstructions") != null) { + fixingInstructions = exceptionMessage.contains((CharSequence) model.getAttribute("caseForInstructions")) ? + (String) model.getAttribute("fixingInstructions") : null; + } + } + new DoneExample() + .withTitle(exampleName) + .withName(title) + .withMessage(exceptionMessage) + .withFixingInstructions(fixingInstructions) + .withStackTracePrinted(stackTrace) + .addToModel(model, config); + return ERROR_PAGE; + } + + private String handleRedirectToCfr(ModelMap model) { + return REDIRECT_CFR_QUICKSTART; + } + + private boolean isTokenExpired() { + Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); + boolean tokenExpired; + OAuth2AuthenticationToken oauth = (OAuth2AuthenticationToken) authentication; + OAuth2User oauthUser = oauth.getPrincipal(); + OAuth2AuthorizedClient oauthClient = authorizedClientService.loadAuthorizedClient( + oauth.getAuthorizedClientRegistrationId(), + oauthUser.getName() + ); + + if (oauthClient != null) { + OAuth2AccessToken accessToken = oauthClient.getAccessToken(); + tokenExpired = accessToken != null && accessToken.getExpiresAt().isBefore(Instant.now()); + } else { + OAuth.OAuthToken accessToken = oauthUser.getAttribute("access_token"); + tokenExpired = accessToken != null && this.session.getTokenExpirationTime() < System.currentTimeMillis(); + } + + session.setRefreshToken(tokenExpired); + + return tokenExpired; + } + + protected CodeExampleText getTextForCodeExample() { + List manifestGroups = config.getCodeExamplesText().APIs.stream() + .filter(x -> ApiType.giveTypeByName(this.exampleName).name().toLowerCase().contains(x.Name.toLowerCase())) + .findFirst() + .orElse(null).Groups; + + int exampleNumberToSearch = Integer.parseInt(this.exampleName.replaceAll("\\D+", "")); + + for (ManifestGroup group : manifestGroups) { + CodeExampleText codeExampleText = group.Examples.stream() + .filter(x -> x.ExampleNumber == exampleNumberToSearch) + .findFirst() + .orElse(null); + + if (codeExampleText != null) { + return codeExampleText; + } + } + return null; + } +} diff --git a/src/main/java/com/docusign/controller/GlobalControllerAdvice.java b/src/main/java/com/docusign/core/controller/GlobalControllerAdvice.java similarity index 54% rename from src/main/java/com/docusign/controller/GlobalControllerAdvice.java rename to src/main/java/com/docusign/core/controller/GlobalControllerAdvice.java index 3bb8a174..ecf4459d 100644 --- a/src/main/java/com/docusign/controller/GlobalControllerAdvice.java +++ b/src/main/java/com/docusign/core/controller/GlobalControllerAdvice.java @@ -1,33 +1,26 @@ -package com.docusign.controller; +package com.docusign.core.controller; import com.docusign.DSConfiguration; +import com.docusign.core.model.*; +import com.docusign.core.utils.AccountsConverter; import com.docusign.esign.client.auth.OAuth; -import com.docusign.model.AuthType; -import com.docusign.model.AuthTypeItem; -import com.docusign.model.Locals; -import com.docusign.model.Session; -import com.docusign.model.User; - -import com.docusign.utils.AccountsConverter; -import java.util.stream.Collectors; import org.apache.commons.lang3.StringUtils; import org.json.JSONObject; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Scope; import org.springframework.security.core.Authentication; import org.springframework.security.core.context.SecurityContextHolder; -import org.springframework.security.oauth2.provider.OAuth2Authentication; -import org.springframework.security.oauth2.provider.authentication.OAuth2AuthenticationDetails; +import org.springframework.security.oauth2.client.OAuth2AuthorizedClient; +import org.springframework.security.oauth2.client.OAuth2AuthorizedClientService; +import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken; +import org.springframework.security.oauth2.core.user.OAuth2User; import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.ModelAttribute; import org.springframework.web.context.WebApplicationContext; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; -import java.util.NoSuchElementException; -import java.util.Optional; - +import java.io.IOException; +import java.util.*; +import java.util.stream.Collectors; /** * This class provides common model attributes for all pages. If you want to @@ -48,14 +41,24 @@ @Scope(WebApplicationContext.SCOPE_SESSION) public class GlobalControllerAdvice { - private static final String BASE_URI_SUFFIX = "/restapi"; private static final String ERROR_ACCOUNT_NOT_FOUND = "Could not find account information for the user"; + private static final String PATH_TO_HOMEPAGE = "/pages/esignature/index"; + private final DSConfiguration config; + private final Session session; + private final User user; + private Optional account; - private AuthType authTypeSelected = AuthType.AGC; + + private final AuthType authTypeSelected = AuthType.AGC; + + private final ApiType apiTypeSelected = ApiType.ESIGNATURE; + + @Autowired + private OAuth2AuthorizedClientService authorizedClientService; @Autowired public GlobalControllerAdvice(DSConfiguration config, Session session, User user, Optional account) { @@ -65,6 +68,35 @@ public GlobalControllerAdvice(DSConfiguration config, Session session, User user this.account = account; } + private static List getOAuthAccounts(OAuth2User user) { + List> oauthAccounts = user.getAttribute("accounts"); + if (oauthAccounts == null) { + return new ArrayList<>(); + } + + return oauthAccounts.stream() + .map(AccountsConverter::convert) + .collect(Collectors.toList()); + } + + private static OAuth.Account getDefaultAccount(List accounts) { + for (OAuth.Account oauthAccount : accounts) { + if ("true".equals(oauthAccount.getIsDefault())) { + return oauthAccount; + } + } + return null; + } + + private static OAuth.Account getAccountById(List accounts, String accountId) { + for (OAuth.Account oauthAccount : accounts) { + if (StringUtils.equals(oauthAccount.getAccountId(), accountId)) { + return oauthAccount; + } + } + return null; + } + @ModelAttribute("authTypes") public List authTypes() { return AuthTypeItem.list(); @@ -75,6 +107,16 @@ public AuthTypeItem authTypeSelected() { return AuthTypeItem.convert(authTypeSelected); } + @ModelAttribute("apiTypes") + public List apiTypes() { + return ApiTypeItem.list(); + } + + @ModelAttribute("apiTypeSelected") + public ApiTypeItem apiTypeSelected() { + return ApiTypeItem.convert(apiTypeSelected); + } + @ModelAttribute("documentOptions") public List populateDocumentOptions() { return new ArrayList<>(); @@ -86,66 +128,56 @@ public boolean populateShowDoc() { } @ModelAttribute("locals") - public Locals populateLocals() { + public Locals populateLocals() throws IOException { Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); - if (!(authentication instanceof OAuth2Authentication)) { + session.setApiIndexPath(PATH_TO_HOMEPAGE); + + if (!(authentication instanceof OAuth2AuthenticationToken)) { return new Locals(config, session, null, ""); } - OAuth2Authentication oauth = (OAuth2Authentication) authentication; - OAuth2AuthenticationDetails details = (OAuth2AuthenticationDetails) oauth.getDetails(); - Authentication oauthUser = oauth.getUserAuthentication(); + OAuth2AuthenticationToken oauth = (OAuth2AuthenticationToken) authentication; + OAuth2User oauthUser = oauth.getPrincipal(); + OAuth2AuthorizedClient oauthClient = authorizedClientService.loadAuthorizedClient( + oauth.getAuthorizedClientRegistrationId(), + oauthUser.getName() + ); - if (oauthUser != null && oauthUser.isAuthenticated()) { - user.setName(oauthUser.getName()); - user.setAccessToken(details.getTokenValue()); + if (oauth.isAuthenticated()) { + user.setName(oauthUser.getAttribute("name")); + + if (oauthClient != null) { + user.setAccessToken(oauthClient.getAccessToken().getTokenValue()); + } else { + user.setAccessToken(((OAuth.OAuthToken) oauthUser.getAttribute("access_token")).getAccessToken()); + } if (account.isEmpty()) { - account = Optional.of(getDefaultAccountInfo(getOAuthAccounts(oauth))); + account = Optional.ofNullable(getDefaultAccountInfo(getOAuthAccounts(oauthUser))); } OAuth.Account oauthAccount = account.orElseThrow(() -> new NoSuchElementException(ERROR_ACCOUNT_NOT_FOUND)); + session.setOauthAccount(oauthAccount); session.setAccountId(oauthAccount.getAccountId()); session.setAccountName(oauthAccount.getAccountName()); - session.setBasePath(oauthAccount.getBaseUri() + BASE_URI_SUFFIX); + + //TODO set this more efficiently with more APIs as they're added in + String basePath = this.config.getBaseUrl(config.getSelectedApiIndex(), oauthAccount) + config.getSelectedApiIndex().getBaseUrlSuffix(); + session.setBasePath(basePath); } return new Locals(config, session, user, ""); } - @SuppressWarnings("unchecked") - private static List getOAuthAccounts(OAuth2Authentication oauth) { - Map userAuthenticationDetails = (Map) oauth.getUserAuthentication().getDetails(); - List> oauthAccounts = (ArrayList>) userAuthenticationDetails.get("accounts"); - return oauthAccounts.stream() - .map(AccountsConverter::convert) - .collect(Collectors.toList()); - } - private OAuth.Account getDefaultAccountInfo(List accounts) { - if (StringUtils.isBlank(config.getTargetAccountId())) { - return getDefaultAccount(accounts); - } - - return getAccountById(accounts); - } - - private static OAuth.Account getDefaultAccount(List accounts) { - for (OAuth.Account oauthAccount : accounts) { - if ("true".equals(oauthAccount.getIsDefault())) { - return oauthAccount; + String targetAccountId = config.getTargetAccountId(); + if (StringUtils.isNotBlank(targetAccountId)) { + OAuth.Account account = getAccountById(accounts, targetAccountId); + if (account != null) { + return account; } } - return null; - } - - private OAuth.Account getAccountById(List accounts) { - for (OAuth.Account oauthAccount : accounts) { - if (StringUtils.equals(oauthAccount.getAccountId(), config.getTargetAccountId())) { - return oauthAccount; - } - } - return null; + return getDefaultAccount(accounts); } } diff --git a/src/main/java/com/docusign/core/controller/IndexController.java b/src/main/java/com/docusign/core/controller/IndexController.java new file mode 100644 index 00000000..6799900c --- /dev/null +++ b/src/main/java/com/docusign/core/controller/IndexController.java @@ -0,0 +1,219 @@ +package com.docusign.core.controller; + +import com.docusign.DSConfiguration; +import com.docusign.common.ApiIndex; +import com.docusign.core.common.Utils; +import com.docusign.core.model.ApiType; +import com.docusign.core.model.AuthType; +import com.docusign.core.model.Session; +import com.docusign.core.model.User; +import com.docusign.core.security.jwt.JWTAuthenticationMethod; +import org.apache.commons.lang3.StringUtils; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.security.core.context.SecurityContextHolder; +import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken; +import org.springframework.security.web.savedrequest.RequestCache; +import org.springframework.security.web.savedrequest.SavedRequest; +import org.springframework.stereotype.Controller; +import org.springframework.ui.ModelMap; +import org.springframework.util.MultiValueMap; +import org.springframework.web.bind.annotation.*; +import org.springframework.web.servlet.ModelAndView; +import org.springframework.web.servlet.view.RedirectView; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.util.List; + +@Controller +public class IndexController { + + public static final String LOCATION_HEADER = "Location"; + + private static final String ATTR_ENVELOPE_ID = "qpEnvelopeId"; + + private static final String ATTR_STATE = "state"; + + private static final String ATTR_EVENT = "event"; + + private static final String ATTR_TITLE = "title"; + + private static final String LAUNCHER_TEXTS = "launcherTexts"; + + private static final String CODE_EXAMPLE_GROUPS = "codeExampleGroups"; + + private static final String API_DATA = "APIData"; + + private static final String STATUS_CFR = "statusCFR"; + + @Autowired + private Session session; + + @Autowired + private User user; + + @Autowired + private RequestCache requestCache; + + @Autowired + private DSConfiguration config; + + @GetMapping(path = "/") + public String index(ModelMap model, HttpServletResponse response) throws Exception { + model.addAttribute(ATTR_TITLE, "Home"); + + Boolean isCFR = false; + + if (this.config.isShareAccessExampleScenario()) { + this.config.setShareAccessExampleScenario(false); + this.config.setAdditionalRedirect(true); + + response.setStatus(response.SC_MOVED_TEMPORARILY); + response.setHeader(LOCATION_HEADER, "/ds/mustAuthenticate"); + return null; + } + + if (this.config.isAdditionalRedirect()) { + this.config.setAdditionalRedirect(false); + + response.setStatus(response.SC_MOVED_TEMPORARILY); + response.setHeader(LOCATION_HEADER, "/eg043/listEnvelopes"); + return null; + } + + if (user.getAccessToken() != null && config.getSelectedApiType().equals(ApiType.ESIGNATURE)) { + try { + isCFR = Utils.isCfr(session.getBasePath(), user.getAccessToken(), session.getAccountId()); + } catch (Exception exception) { + return exception.toString(); + } + } + + if (config.getQuickstart().equals("true") && config.getSelectedApiIndex().equals(ApiIndex.ESIGNATURE) && + !(SecurityContextHolder.getContext().getAuthentication() instanceof OAuth2AuthenticationToken)) { + String site = ApiIndex.ESIGNATURE.getPathOfFirstExample(); + response.setStatus(response.SC_MOVED_TEMPORARILY); + response.setHeader(LOCATION_HEADER, site); + return null; + } + + if (isCFR) { + session.setStatusCFR("enabled"); + model.addAttribute(STATUS_CFR, "enabled"); + } + model.addAttribute(LAUNCHER_TEXTS, config.getCodeExamplesText().SupportingTexts); + model.addAttribute(CODE_EXAMPLE_GROUPS, config.getCodeExamplesText().APIs.toArray()); + model.addAttribute(API_DATA, config.loadFileData(config.getCodeExamplesManifest())); + return session.getApiIndexPath(); + } + + @GetMapping(path = "/ds/mustAuthenticate") + public ModelAndView mustAuthenticateController(ModelMap model, HttpServletRequest req, HttpServletResponse resp) throws IOException { + model.addAttribute(LAUNCHER_TEXTS, config.getCodeExamplesText().SupportingTexts); + model.addAttribute(ATTR_TITLE, config.getCodeExamplesText().SupportingTexts.LoginPage.LoginButton); + + String redirectURL = getRedirectURLForJWTAuthentication(req, resp); + + if (config.getIsConsentRedirectActivated()) { + config.setIsConsentRedirectActivated(false); + this.session.setAuthTypeSelected(AuthType.JWT); + + return new ModelAndView(new JWTAuthenticationMethod().loginUsingJWT(config, session, redirectURL)); + } + + if (session.isRefreshToken() || config.getQuickstart().equals("true")) { + config.setQuickstart("false"); + + if (redirectURL.toLowerCase().contains("/m") || session.getMonitorExampleRedirect() != null) { + return checkForMonitorRedirects(redirectURL); + } + + return new ModelAndView(getRedirectView(session.getAuthTypeSelected())); + } else if (redirectURL.toLowerCase().contains("/m") || session.getMonitorExampleRedirect() != null) { + return checkForMonitorRedirects(redirectURL); + } else { + return new ModelAndView("pages/ds_must_authenticate"); + } + } + + private ModelAndView checkForMonitorRedirects(String redirectURL) { + this.session.setAuthTypeSelected(AuthType.JWT); + redirectURL = redirectURL != "/" ? redirectURL : session.getMonitorExampleRedirect(); + this.session.setMonitorExampleRedirect(null); + return new ModelAndView(new JWTAuthenticationMethod().loginUsingJWT(config, session, redirectURL)); + } + + @RequestMapping(path = "/ds/authenticate", method = RequestMethod.POST) + public RedirectView authenticate(ModelMap model, @RequestBody MultiValueMap formParams, HttpServletRequest req, HttpServletResponse resp) throws IOException { + if (!formParams.containsKey("selectAuthType")) { + model.addAttribute("message", "Select option with selectAuthType name must be provided."); + return new RedirectView("pages/error"); + } + + String redirectURL = getRedirectURLForJWTAuthentication(req, resp); + + List selectAuthTypeObject = formParams.get("selectAuthType"); + AuthType authTypeSelected = AuthType.valueOf(selectAuthTypeObject.get(0)); + + if (authTypeSelected.equals(AuthType.JWT)) { + this.session.setAuthTypeSelected(AuthType.JWT); + return new JWTAuthenticationMethod().loginUsingJWT(config, session, redirectURL); + } else { + this.session.setAuthTypeSelected(AuthType.AGC); + return getRedirectView(authTypeSelected); + } + } + + private String getRedirectURLForJWTAuthentication(HttpServletRequest req, HttpServletResponse resp) { + SavedRequest savedRequest = requestCache.getRequest(req, resp); + + String[] examplesCodes = new String[]{ + ApiIndex.CLICK.getExamplesPathCode(), + ApiIndex.ESIGNATURE.getExamplesPathCode(), + ApiIndex.MONITOR.getExamplesPathCode(), + ApiIndex.ADMIN.getExamplesPathCode(), + ApiIndex.ROOMS.getExamplesPathCode(), + }; + + if (savedRequest != null) { + Integer indexOfExampleCodeInRedirect = StringUtils.indexOfAny(savedRequest.getRedirectUrl(), examplesCodes); + + if (indexOfExampleCodeInRedirect != -1) { + Boolean hasNumbers = savedRequest.getRedirectUrl().substring(indexOfExampleCodeInRedirect).matches(".*\\d.*"); + + return "GET".equals(savedRequest.getMethod()) && hasNumbers ? + savedRequest.getRedirectUrl() : "/"; + } + } + + return "/"; + } + + @GetMapping(path = "/ds-return") + public String returnController(@RequestParam(value = ATTR_STATE, required = false) String state, + @RequestParam(value = ATTR_EVENT, required = false) String event, + @RequestParam(value = "envelopeId", required = false) String envelopeId, ModelMap model) { + model.addAttribute(LAUNCHER_TEXTS, config.getCodeExamplesText().SupportingTexts); + model.addAttribute(ATTR_TITLE, "Return from DocuSign"); + model.addAttribute(ATTR_EVENT, event); + model.addAttribute(ATTR_STATE, state); + model.addAttribute(ATTR_ENVELOPE_ID, envelopeId); + return "pages/ds_return"; + } + + private RedirectView getRedirectView(AuthType authTypeSelected) { + session.setAuthTypeSelected(authTypeSelected); + RedirectView redirect = new RedirectView(getLoginPath(authTypeSelected)); + redirect.setExposeModelAttributes(false); + return redirect; + } + + private String getLoginPath(AuthType authTypeSelected) { + String loginPath = config.getAcgRedirectURL(); + if (authTypeSelected.equals(AuthType.JWT)) { + loginPath = config.getJwtRedirectURL(); + } + return loginPath; + } +} diff --git a/src/main/java/com/docusign/exception/LauncherException.java b/src/main/java/com/docusign/core/exception/LauncherException.java similarity index 84% rename from src/main/java/com/docusign/exception/LauncherException.java rename to src/main/java/com/docusign/core/exception/LauncherException.java index a7eae46d..536e07a1 100644 --- a/src/main/java/com/docusign/exception/LauncherException.java +++ b/src/main/java/com/docusign/core/exception/LauncherException.java @@ -1,4 +1,4 @@ -package com.docusign.exception; +package com.docusign.core.exception; public class LauncherException extends Exception { diff --git a/src/main/java/com/docusign/model/AccountRoleSettingsPatch.java b/src/main/java/com/docusign/core/model/AccountRoleSettingsPatch.java similarity index 54% rename from src/main/java/com/docusign/model/AccountRoleSettingsPatch.java rename to src/main/java/com/docusign/core/model/AccountRoleSettingsPatch.java index 8696d76d..6694ff03 100644 --- a/src/main/java/com/docusign/model/AccountRoleSettingsPatch.java +++ b/src/main/java/com/docusign/core/model/AccountRoleSettingsPatch.java @@ -1,27 +1,16 @@ -package com.docusign.model; +package com.docusign.core.model; import com.docusign.esign.model.AccountRoleSettings; import com.fasterxml.jackson.annotation.JsonProperty; -import io.swagger.annotations.ApiModelProperty; +import io.swagger.v3.oas.annotations.media.Schema; public class AccountRoleSettingsPatch extends AccountRoleSettings { @JsonProperty("signingUiVersion") - private String signingUiVersion = null; + private String signingUiVersion = ""; public AccountRoleSettings signingUiVersion(String signingUiVersion) { this.signingUiVersion = signingUiVersion; return this; } - - /** - * - * @return signingUiVersion - **/ - @ApiModelProperty(example = "null", value = "") - public String getSigningUiVersion() { - return signingUiVersion; - } - - } diff --git a/src/main/java/com/docusign/core/model/ApiType.java b/src/main/java/com/docusign/core/model/ApiType.java new file mode 100644 index 00000000..ab8b4ab7 --- /dev/null +++ b/src/main/java/com/docusign/core/model/ApiType.java @@ -0,0 +1,39 @@ +package com.docusign.core.model; + +import java.util.Arrays; + +public enum ApiType { + ESIGNATURE("eSignature API", new String[]{"signature"}, "eg"), + ROOMS("Rooms API", new String[]{"signature", "dtr.rooms.read", "dtr.rooms.write", "dtr.documents.read", "dtr.documents.write", "dtr.profile.read", "dtr.profile.write", "dtr.company.read", "dtr.company.write", "room_forms"}, "r"), + CONNECT("Connect", new String[] {}, "con"), + CLICK("Click API", new String[] {"click.manage", "click.send"}, "c"), + MONITOR("Monitor API", new String[] {"signature", "impersonation"}, "m"), + ADMIN("Admin API", new String[] {"user_write", "signature", "impersonation", "group_read", "organization_read", "permission_read", "user_read", "account_read", "domain_read", "identity_provider_read", "user_data_redact", "asset_group_account_read", "asset_group_account_clone_write", "asset_group_account_clone_read"}, "a"); + + final String value; + + final String[] scopes; + + final String codeName; + + ApiType(String value, String[] scopes, String codeName) { + this.value = value; + this.scopes = scopes; + this.codeName = codeName; + } + + public static ApiType giveTypeByName(String exampleName) { + return Arrays.stream(ApiType.values()) + .filter(x -> exampleName.contains(x.getCodeName())) + .findFirst() + .get(); + } + + public String[] getScopes() { + return scopes; + } + + public String getCodeName() { + return codeName; + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/core/model/ApiTypeItem.java b/src/main/java/com/docusign/core/model/ApiTypeItem.java new file mode 100644 index 00000000..9af9cf24 --- /dev/null +++ b/src/main/java/com/docusign/core/model/ApiTypeItem.java @@ -0,0 +1,47 @@ +package com.docusign.core.model; + +import java.util.EnumSet; +import java.util.List; +import java.util.stream.Collectors; + +public class ApiTypeItem { + + private String key; + + private String value; + + public ApiTypeItem(String key, String value) { + this.key = key; + this.value = value; + } + + public static ApiTypeItem convert(ApiType apiType) { + return new ApiTypeItem(apiType.name(), apiType.value); + } + + public static ApiType convert(ApiTypeItem apiType) { + return ApiType.valueOf(apiType.key); + } + + public static List list() { + return EnumSet.allOf(ApiType.class).stream() + .map(ApiTypeItem::convert) + .collect(Collectors.toList()); + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } + + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } +} diff --git a/src/main/java/com/docusign/model/AuthType.java b/src/main/java/com/docusign/core/model/AuthType.java similarity index 87% rename from src/main/java/com/docusign/model/AuthType.java rename to src/main/java/com/docusign/core/model/AuthType.java index 03dec8ac..1fbbaeb8 100644 --- a/src/main/java/com/docusign/model/AuthType.java +++ b/src/main/java/com/docusign/core/model/AuthType.java @@ -1,4 +1,4 @@ -package com.docusign.model; +package com.docusign.core.model; public enum AuthType { //Authorization Code Grant diff --git a/src/main/java/com/docusign/model/AuthTypeItem.java b/src/main/java/com/docusign/core/model/AuthTypeItem.java similarity index 96% rename from src/main/java/com/docusign/model/AuthTypeItem.java rename to src/main/java/com/docusign/core/model/AuthTypeItem.java index c27c38bf..3701422a 100644 --- a/src/main/java/com/docusign/model/AuthTypeItem.java +++ b/src/main/java/com/docusign/core/model/AuthTypeItem.java @@ -1,4 +1,4 @@ -package com.docusign.model; +package com.docusign.core.model; import java.util.EnumSet; import java.util.List; @@ -7,6 +7,7 @@ public class AuthTypeItem { private String key; + private String value; public AuthTypeItem(String key, String value) { @@ -14,6 +15,20 @@ public AuthTypeItem(String key, String value) { this.value = value; } + public static AuthTypeItem convert(AuthType authType) { + return new AuthTypeItem(authType.name(), authType.value); + } + + public static AuthType convert(AuthTypeItem authType) { + return AuthType.valueOf(authType.key); + } + + public static List list() { + return EnumSet.allOf(AuthType.class).stream() + .map(AuthTypeItem::convert) + .collect(Collectors.toList()); + } + public String getKey() { return key; } @@ -29,18 +44,4 @@ public String getValue() { public void setValue(String value) { this.value = value; } - - public static AuthTypeItem convert(AuthType authType) { - return new AuthTypeItem(authType.name(), authType.value); - } - - public static AuthType convert(AuthTypeItem authType) { - return AuthType.valueOf(authType.key); - } - - public static List list() { - return EnumSet.allOf(AuthType.class).stream() - .map(AuthTypeItem::convert) - .collect(Collectors.toList()); - } } diff --git a/src/main/java/com/docusign/core/model/DoneExample.java b/src/main/java/com/docusign/core/model/DoneExample.java new file mode 100644 index 00000000..498ce297 --- /dev/null +++ b/src/main/java/com/docusign/core/model/DoneExample.java @@ -0,0 +1,163 @@ +package com.docusign.core.model; + +import com.docusign.DSConfiguration; +import com.docusign.core.common.DiffField; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.util.DefaultPrettyPrinter; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.ObjectWriter; +import com.fasterxml.jackson.datatype.joda.JodaModule; +import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; +import lombok.With; +import org.springframework.ui.ModelMap; + +import java.text.SimpleDateFormat; + + +/** + * Model which is used in 'done' pages. + */ +@Data +@AllArgsConstructor +@NoArgsConstructor +@With +public class DoneExample { + public static final int JSON_INDENT_FACTOR = 4; + + private static final String MODEL_DONE_ATTRIBUTE = "done"; + + private static final String DATETIME_PATTERN = "yyyy-MM-dd'T'HH:mm:ssz"; + + private static final String LAUNCHER_TEXTS = "launcherTexts"; + + private String formFillUrl; + + private String title; + + private String name; + + private String message; + + private String redirect; + + private String json; + + private StackTraceElement[] stackTrace; + + private String stackTracePrinted; + + private String fixingInstructions; + + private Iterable diff; + + /** + * Creates default DoneExample object. This method initializes title and + * name members by the same value. + * + * @param title the title text + * @return created instance of this class + */ + public static DoneExample createDefault(String title) { + return new DoneExample() + .withTitle(title) + .withName(title); + } + + /** + * Creates DoneExample object with title. This method initializes title. + * + * @param String title + * @return created instance of this class + */ + public DoneExample withTitle(String title) { + this.title = title; + return this; + } + + /** + * Creates DoneExample object with name. This method initializes name. + * + * @param String name + * @return created instance of this class + */ + public DoneExample withName(String name) { + this.name = name; + return this; + } + + /** + * Creates DoneExample object with message. This method initializes message. + * + * @param String message + * @return created instance of this class + */ + public DoneExample withMessage(String message) { + this.message = message; + return this; + } + + public DoneExample withFixingInstructions(String fixingInstructions) { + this.fixingInstructions = fixingInstructions; + return this; + } + + /** + * Creates DoneExample object with stackTrace. This method initializes error stack trace. + * + * @param StackTraceElement[] stackTrace + * @return created instance of this class + */ + public DoneExample withStackTrace(StackTraceElement[] stackTrace) { + this.stackTrace = stackTrace; + return this; + } + + public DoneExample withStackTracePrinted(String stackTracePrinted) { + this.stackTracePrinted = stackTracePrinted; + return this; + } + + /** + * Creates a JSON text from the object and applies it to member + * + * @param object the object to convert to JSON string + * @return this object + */ + public DoneExample withJsonObject(Object object) { + if (object != null) { + ObjectWriter writer = new ObjectMapper() + .registerModule(new JavaTimeModule()) + .registerModule(new JodaModule()) + .setDateFormat(new SimpleDateFormat(DATETIME_PATTERN)) + .setDefaultPrettyPrinter(new DefaultPrettyPrinter()) + .writerWithDefaultPrettyPrinter(); + try { + json = writer.writeValueAsString(object); + } catch (JsonProcessingException e) { + e.printStackTrace(); + } + } + return this; + } + + public DoneExample withFormFill(String url) { + if (url != null) { + this.formFillUrl = url; + } + + return this; + } + + /** + * Adds this object to model map using name 'done' + * + * @param model the model object to add + */ + public void addToModel(ModelMap model, DSConfiguration config) { + model.addAttribute(MODEL_DONE_ATTRIBUTE, this); + model.addAttribute(LAUNCHER_TEXTS, config.getCodeExamplesText().SupportingTexts); + } +} diff --git a/src/main/java/com/docusign/model/EnvelopeDocumentInfo.java b/src/main/java/com/docusign/core/model/EnvelopeDocumentInfo.java similarity index 88% rename from src/main/java/com/docusign/model/EnvelopeDocumentInfo.java rename to src/main/java/com/docusign/core/model/EnvelopeDocumentInfo.java index 1525b3ea..fb87615f 100644 --- a/src/main/java/com/docusign/model/EnvelopeDocumentInfo.java +++ b/src/main/java/com/docusign/core/model/EnvelopeDocumentInfo.java @@ -1,15 +1,17 @@ -package com.docusign.model; - -import java.io.Serializable; +package com.docusign.core.model; import lombok.Value; +import java.io.Serializable; + @Value public class EnvelopeDocumentInfo implements Serializable { private static final long serialVersionUID = 8423772017910727550L; private String name; + private String type; + private String documentId; } diff --git a/src/main/java/com/docusign/model/Locals.java b/src/main/java/com/docusign/core/model/Locals.java similarity index 88% rename from src/main/java/com/docusign/model/Locals.java rename to src/main/java/com/docusign/core/model/Locals.java index 9c1200d0..82a1f5f7 100644 --- a/src/main/java/com/docusign/model/Locals.java +++ b/src/main/java/com/docusign/core/model/Locals.java @@ -1,15 +1,17 @@ -package com.docusign.model; +package com.docusign.core.model; +import com.docusign.DSConfiguration; import lombok.AllArgsConstructor; import lombok.Data; -import com.docusign.DSConfiguration; - @Data @AllArgsConstructor public class Locals { private DSConfiguration dsConfig; + private Session session; + private User user; + private String messages; } diff --git a/src/main/java/com/docusign/model/OptionItem.java b/src/main/java/com/docusign/core/model/OptionItem.java similarity index 83% rename from src/main/java/com/docusign/model/OptionItem.java rename to src/main/java/com/docusign/core/model/OptionItem.java index 09b3fec7..71621e67 100644 --- a/src/main/java/com/docusign/model/OptionItem.java +++ b/src/main/java/com/docusign/core/model/OptionItem.java @@ -1,4 +1,4 @@ -package com.docusign.model; +package com.docusign.core.model; import lombok.AllArgsConstructor; import lombok.Data; @@ -8,5 +8,6 @@ @AllArgsConstructor public class OptionItem { private String text; + private String documentId; } diff --git a/src/main/java/com/docusign/core/model/Session.java b/src/main/java/com/docusign/core/model/Session.java new file mode 100644 index 00000000..a2bc0a17 --- /dev/null +++ b/src/main/java/com/docusign/core/model/Session.java @@ -0,0 +1,70 @@ +package com.docusign.core.model; + +import com.docusign.esign.client.auth.OAuth; +import lombok.Data; +import org.springframework.context.annotation.Scope; +import org.springframework.context.annotation.ScopedProxyMode; +import org.springframework.stereotype.Component; +import org.springframework.web.context.WebApplicationContext; + +import java.io.Serializable; +import java.util.List; +import java.util.UUID; + +@Component +@Scope(value = WebApplicationContext.SCOPE_SESSION, + proxyMode = ScopedProxyMode.TARGET_CLASS) +@Data +public class Session implements Serializable { + private static final long serialVersionUID = 2695379118371574037L; + + public UUID bulkListId; + + public Long tokenExpirationTime; + + private String accountId; + + private String createdUserId; + + private String accountName; + + private String basePath; + + private String roomsBasePath; + + private String envelopeId; + + private String templateId; + + private String templateName; + + private String statusCFR; + + private List envelopeDocuments; + + private String permissionProfileId; + + private String permissionProfileName; + + private String apiIndexPath; + + private AuthType authTypeSelected = AuthType.AGC; + + private boolean refreshToken; + + private String clickwrapId; + + private String clickwrapVersionNumber; + + private String exportId; + + private String importId; + + private String emailAddress; + + private UUID orgId; + + private OAuth.Account oauthAccount; + + private String monitorExampleRedirect; +} diff --git a/src/main/java/com/docusign/model/User.java b/src/main/java/com/docusign/core/model/User.java similarity index 94% rename from src/main/java/com/docusign/model/User.java rename to src/main/java/com/docusign/core/model/User.java index 5fa6b558..6e4ac15d 100644 --- a/src/main/java/com/docusign/model/User.java +++ b/src/main/java/com/docusign/core/model/User.java @@ -1,14 +1,13 @@ -package com.docusign.model; +package com.docusign.core.model; import lombok.Data; - -import java.io.Serializable; - import org.springframework.context.annotation.Scope; import org.springframework.context.annotation.ScopedProxyMode; import org.springframework.stereotype.Component; import org.springframework.web.context.WebApplicationContext; +import java.io.Serializable; + @Component @Scope(value = WebApplicationContext.SCOPE_SESSION, @@ -18,5 +17,6 @@ public class User implements Serializable { private static final long serialVersionUID = 8959083682339598499L; private String name; + private String accessToken; } diff --git a/src/main/java/com/docusign/core/model/manifestModels/APIs.java b/src/main/java/com/docusign/core/model/manifestModels/APIs.java new file mode 100644 index 00000000..5cae44b3 --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/APIs.java @@ -0,0 +1,15 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +import java.util.ArrayList; +import java.util.List; + +@Getter +@Setter +public class APIs { + public String Name; + + public List Groups = new ArrayList(); +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/AdditionalPage.java b/src/main/java/com/docusign/core/model/manifestModels/AdditionalPage.java new file mode 100644 index 00000000..8ff04d08 --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/AdditionalPage.java @@ -0,0 +1,12 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +public class AdditionalPage { + public String Name; + + public String ResultsPageText; +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/CodeExampleText.java b/src/main/java/com/docusign/core/model/manifestModels/CodeExampleText.java new file mode 100644 index 00000000..e3ad7124 --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/CodeExampleText.java @@ -0,0 +1,35 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +import java.util.ArrayList; +import java.util.List; + +@Getter +@Setter +public class CodeExampleText { + public int ExampleNumber; + + public String ExampleName; + + public String CFREnabled; + + public String ExampleDescription; + + public String Notes; + + public String ResultsPageText; + + public String SkipForLanguages; + + public List LinksToAPIMethod = new ArrayList<>(); + + public List CustomErrorTexts = new ArrayList<>(); + + public List RedirectsToOtherCodeExamples = new ArrayList<>(); + + public List Forms = new ArrayList<>(); + + public List AdditionalPage = new ArrayList<>(); +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/CustomErrorTexts.java b/src/main/java/com/docusign/core/model/manifestModels/CustomErrorTexts.java new file mode 100644 index 00000000..056719dc --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/CustomErrorTexts.java @@ -0,0 +1,12 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +public class CustomErrorTexts { + public String ErrorMessageCheck; + + public String ErrorMessage; +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/Forms.java b/src/main/java/com/docusign/core/model/manifestModels/Forms.java new file mode 100644 index 00000000..e18ac68f --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/Forms.java @@ -0,0 +1,15 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +import java.util.ArrayList; +import java.util.List; + +@Getter +@Setter +public class Forms { + public String FormName; + + public List Inputs = new ArrayList<>(); +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/HelpingTexts.java b/src/main/java/com/docusign/core/model/manifestModels/HelpingTexts.java new file mode 100644 index 00000000..2c87faea --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/HelpingTexts.java @@ -0,0 +1,38 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +public class HelpingTexts { + public String EmailWontBeShared; + + public String SaveAgentActivationCode; + + public String PhoneNumberWontBeShared; + + public String CCEmailShouldDifferFromSigner; + + public String AccessCodeText; + + public String CountryCodeText; + + public String ChooseDateInTheFuture; + + public String PhoneNumberWillBeNotified; + + public String EmailAddressOfUserToDelete; + + public String UserIDOfUserToDelete; + + public String DynamicContentValue; + + public String DynamicContentNote; + + public String EmbedClickwrapURL; + + public String NOTAGREED; + + public String AGREED; +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/Inputs.java b/src/main/java/com/docusign/core/model/manifestModels/Inputs.java new file mode 100644 index 00000000..c0b997b2 --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/Inputs.java @@ -0,0 +1,12 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +public class Inputs { + public String InputName; + + public String InputPlaceholder; +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/LinkToAPIMethods.java b/src/main/java/com/docusign/core/model/manifestModels/LinkToAPIMethods.java new file mode 100644 index 00000000..93d905fb --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/LinkToAPIMethods.java @@ -0,0 +1,12 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +public class LinkToAPIMethods { + public String Path; + + public String PathName; +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/LoginPage.java b/src/main/java/com/docusign/core/model/manifestModels/LoginPage.java new file mode 100644 index 00000000..2b9ee96f --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/LoginPage.java @@ -0,0 +1,14 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +public class LoginPage { + public String LoginHeader; + + public String LoginButton; + + public String LoginHelperText; +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/ManifestGroup.java b/src/main/java/com/docusign/core/model/manifestModels/ManifestGroup.java new file mode 100644 index 00000000..b09bc3ed --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/ManifestGroup.java @@ -0,0 +1,15 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +import java.util.ArrayList; +import java.util.List; + +@Getter +@Setter +public class ManifestGroup { + public List Examples = new ArrayList<>(); + + public String Name; +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/ManifestStructure.java b/src/main/java/com/docusign/core/model/manifestModels/ManifestStructure.java new file mode 100644 index 00000000..33d11773 --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/ManifestStructure.java @@ -0,0 +1,15 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +import java.util.ArrayList; +import java.util.List; + +@Getter +@Setter +public class ManifestStructure { + public SupportingTexts SupportingTexts; + + public List APIs = new ArrayList(); +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/RedirectsToOtherCodeExamples.java b/src/main/java/com/docusign/core/model/manifestModels/RedirectsToOtherCodeExamples.java new file mode 100644 index 00000000..10bb8803 --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/RedirectsToOtherCodeExamples.java @@ -0,0 +1,12 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +public class RedirectsToOtherCodeExamples { + public Integer CodeExampleToRedirectTo; + + public String RedirectText; +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/SelectAPIPage.java b/src/main/java/com/docusign/core/model/manifestModels/SelectAPIPage.java new file mode 100644 index 00000000..61f84666 --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/SelectAPIPage.java @@ -0,0 +1,12 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +public class SelectAPIPage { + public String SelectAPIHeader; + + public String SelectAPIButton; +} diff --git a/src/main/java/com/docusign/core/model/manifestModels/SupportingTexts.java b/src/main/java/com/docusign/core/model/manifestModels/SupportingTexts.java new file mode 100644 index 00000000..1536f493 --- /dev/null +++ b/src/main/java/com/docusign/core/model/manifestModels/SupportingTexts.java @@ -0,0 +1,40 @@ +package com.docusign.core.model.manifestModels; + +import lombok.Getter; +import lombok.Setter; + +@Getter +@Setter +public class SupportingTexts { + public String HomePageText; + + public String ViewSourceFile; + + public String APIMethodUsed; + + public String APIMethodUsedPlural; + + public String SubmitButton; + + public String ContinueButton; + + public String HomeButton; + + public String LoginButton; + + public String LogoutButton; + + public String SearchFailed; + + public String ChangeAPITypeButton; + + public String WelcomeText; + + public String CFRError; + + public LoginPage LoginPage; + + public SelectAPIPage SelectAPIPage; + + public HelpingTexts HelpingTexts; +} diff --git a/src/main/java/com/docusign/core/security/jwt/JWTAuthenticationMethod.java b/src/main/java/com/docusign/core/security/jwt/JWTAuthenticationMethod.java new file mode 100644 index 00000000..6fd322ff --- /dev/null +++ b/src/main/java/com/docusign/core/security/jwt/JWTAuthenticationMethod.java @@ -0,0 +1,105 @@ +package com.docusign.core.security.jwt; + +import com.docusign.DSConfiguration; +import com.docusign.core.model.ApiType; +import com.docusign.core.model.Session; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.client.auth.OAuth; +import org.springframework.security.core.context.SecurityContextHolder; +import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken; +import org.springframework.web.servlet.view.RedirectView; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +public class JWTAuthenticationMethod { + + public static final String CONSENT_REQUIRED = "consent_required"; + + public static final String REQUEST_CONSENT_LINK = "https://%s/oauth/auth?prompt=login&response_type=code&scope=%s&client_id=%s&redirect_uri=%s"; + + public static final String CONSENT_REDIRECT_URL = "http://localhost:8080/login/oauth2/code/jwt"; + + private static final long TOKEN_EXPIRATION_IN_SECONDS = 3600; + + public RedirectView loginUsingJWT( + DSConfiguration configuration, + Session session, + String redirectURL) { + List scopes = new ArrayList<>(); + for (ApiType scope : ApiType.values()) { + scopes.addAll(Arrays.asList(scope.getScopes())); + } + + try { + ApiClient apiClient = new ApiClient(configuration.getBasePath()); + byte[] privateKeyBytes = Files.readAllBytes(Paths.get(configuration.getPrivateKeyPath())); + + OAuth.OAuthToken oAuthToken = apiClient.requestJWTUserToken( + configuration.getUserId(), + configuration.getImpersonatedUserId(), + scopes, + privateKeyBytes, + TOKEN_EXPIRATION_IN_SECONDS); + String accessToken = oAuthToken.getAccessToken(); + OAuth.UserInfo userInfo = apiClient.getUserInfo(accessToken); + String accountId = userInfo.getAccounts().size() > 0 ? + userInfo.getAccounts().get(0).getAccountId() + : ""; + + setSpringSecurityAuthentication(scopes, oAuthToken, userInfo, accountId, session); + } catch (ApiException | IOException exp) { + if (exp.getMessage().contains(CONSENT_REQUIRED)) { + String consent_scopes = String.join("%20", scopes) + "%20impersonation"; + + var consent_url = String.format( + REQUEST_CONSENT_LINK, + configuration.getBaseURL(), + consent_scopes, + configuration.getUserId(), + CONSENT_REDIRECT_URL); + + System.err.println("\nC O N S E N T R E Q U I R E D" + + "\nAsk the user who will be impersonated to run the following URL: " + + "\n" + consent_url + + "\n\nIt will ask the user to login and to approve access by your application." + + "\nAlternatively, an Administrator can use Organization Administration to" + + "\npre-approve one or more users."); + + configuration.setIsConsentRedirectActivated(true); + + return new RedirectView(consent_url); + } + } + + return new RedirectView(redirectURL); + } + + private void setSpringSecurityAuthentication( + List scopes, + OAuth.OAuthToken oAuthToken, + OAuth.UserInfo userInfo, + String accountId, + Session session) { + JWTOAuth2User principal = new JWTOAuth2User(); + principal.setAuthorities(scopes); + principal.setCreated(userInfo.getCreated()); + principal.setName(userInfo.getName()); + principal.setGivenName(userInfo.getGivenName()); + principal.setFamilyName(userInfo.getFamilyName()); + principal.setSub(userInfo.getSub()); + principal.setEmail(userInfo.getEmail()); + principal.setAccounts(userInfo.getAccounts()); + principal.setAccessToken(oAuthToken); + + session.setTokenExpirationTime(System.currentTimeMillis() + oAuthToken.getExpiresIn() * 1000L); + + OAuth2AuthenticationToken token = new OAuth2AuthenticationToken(principal, principal.getAuthorities(), accountId); + SecurityContextHolder.getContext().setAuthentication(token); + } +} diff --git a/src/main/java/com/docusign/core/security/jwt/JWTOAuth2User.java b/src/main/java/com/docusign/core/security/jwt/JWTOAuth2User.java new file mode 100644 index 00000000..ef881415 --- /dev/null +++ b/src/main/java/com/docusign/core/security/jwt/JWTOAuth2User.java @@ -0,0 +1,130 @@ +package com.docusign.core.security.jwt; + +import com.docusign.esign.client.auth.OAuth; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.springframework.security.core.GrantedAuthority; +import org.springframework.security.core.authority.AuthorityUtils; +import org.springframework.security.oauth2.core.user.OAuth2User; + +import java.util.*; + +public class JWTOAuth2User implements OAuth2User { + private List authorities; + + private Map attributes; + + private String sub; + + private String name; + + private String givenName; + + private String familyName; + + private OAuth.OAuthToken accessToken; + + private String email; + + private List> accounts; + + private String created; + + @Override + public Collection getAuthorities() { + return this.authorities; + } + + public void setAuthorities(List scopes) { + String authoritiesString = "ROLE_USER"; + for (String scope : scopes) { + authoritiesString += ",SCOPE_" + scope; + } + authorities = AuthorityUtils.commaSeparatedStringToAuthorityList(authoritiesString); + } + + @Override + public Map getAttributes() { + if (this.attributes == null) { + this.attributes = new HashMap<>(); + this.attributes.put("sub", this.getSub()); + this.attributes.put("name", this.getName()); + this.attributes.put("given_name", this.getGivenName()); + this.attributes.put("family_name", this.getFamilyName()); + this.attributes.put("created", this.getCreated()); + this.attributes.put("email", this.getEmail()); + this.attributes.put("accounts", this.getAccounts()); + this.attributes.put("access_token", this.getAccessToken()); + } + return attributes; + } + + public String getSub() { + return this.sub; + } + + public void setSub(String sub) { + this.sub = sub; + } + + @Override + public String getName() { + return this.name; + } + + public void setName(String name) { + this.name = name; + } + + public String getGivenName() { + return this.givenName; + } + + public void setGivenName(String givenName) { + this.givenName = givenName; + } + + public OAuth.OAuthToken getAccessToken() { + return this.accessToken; + } + + public void setAccessToken(OAuth.OAuthToken accessToken) { + this.accessToken = accessToken; + } + + public String getFamilyName() { + return this.familyName; + } + + public void setFamilyName(String familyName) { + this.familyName = familyName; + } + + public String getCreated() { + return this.created; + } + + public void setCreated(String created) { + this.created = created; + } + + public String getEmail() { + return this.email; + } + + public void setEmail(String email) { + this.email = email; + } + + public List> getAccounts() { + return this.accounts; + } + + public void setAccounts(List accounts) { + this.accounts = new ArrayList<>(); + for (OAuth.Account account : accounts) { + ObjectMapper mapObject = new ObjectMapper(); + Map mapObj = mapObject.convertValue(account, Map.class); + this.accounts.add(mapObj); + } + } +} \ No newline at end of file diff --git a/src/main/java/com/docusign/utils/AccountsConverter.java b/src/main/java/com/docusign/core/utils/AccountsConverter.java similarity index 96% rename from src/main/java/com/docusign/utils/AccountsConverter.java rename to src/main/java/com/docusign/core/utils/AccountsConverter.java index b01c5a98..b9886b78 100644 --- a/src/main/java/com/docusign/utils/AccountsConverter.java +++ b/src/main/java/com/docusign/core/utils/AccountsConverter.java @@ -1,6 +1,7 @@ -package com.docusign.utils; +package com.docusign.core.utils; import com.docusign.esign.client.auth.OAuth; + import java.util.LinkedHashMap; import java.util.Map; diff --git a/src/main/java/com/docusign/core/utils/DateUtils.java b/src/main/java/com/docusign/core/utils/DateUtils.java new file mode 100644 index 00000000..0e280b02 --- /dev/null +++ b/src/main/java/com/docusign/core/utils/DateUtils.java @@ -0,0 +1,9 @@ +package com.docusign.core.utils; + +import java.time.format.DateTimeFormatter; + +public class DateUtils { + public static final DateTimeFormatter DATE_WITH_SLASH = DateTimeFormatter.ofPattern("yyyy/MM/dd"); + + public static final DateTimeFormatter DATE_WITH_LINES = DateTimeFormatter.ofPattern("yyyy-MM-dd"); +} diff --git a/src/main/java/com/docusign/core/utils/FileUtils.java b/src/main/java/com/docusign/core/utils/FileUtils.java new file mode 100644 index 00000000..5e81a1c0 --- /dev/null +++ b/src/main/java/com/docusign/core/utils/FileUtils.java @@ -0,0 +1,20 @@ +package com.docusign.core.utils; + +import org.springframework.core.io.ClassPathResource; +import org.springframework.util.StreamUtils; + +import java.io.IOException; + +public class FileUtils { + /** + * Loads a file content and copy it into a byte array. + * + * @param path the absolute path within the class path + * @return the new byte array that has been loaded from the file + * @throws IOException in case of I/O errors + */ + public static byte[] readFile(String path) throws IOException { + ClassPathResource resource = new ClassPathResource(path); + return StreamUtils.copyToByteArray(resource.getInputStream()); + } +} diff --git a/src/main/java/com/docusign/model/DoneExample.java b/src/main/java/com/docusign/model/DoneExample.java deleted file mode 100644 index a6d41836..00000000 --- a/src/main/java/com/docusign/model/DoneExample.java +++ /dev/null @@ -1,65 +0,0 @@ -package com.docusign.model; - -import org.json.JSONObject; -import org.springframework.ui.ModelMap; - -import com.docusign.common.DiffField; - -import lombok.AllArgsConstructor; -import lombok.Data; -import lombok.NoArgsConstructor; -import lombok.With; - - -/** - * Model which is used in 'done' pages. - */ -@Data -@AllArgsConstructor -@NoArgsConstructor -@With -public class DoneExample { - private static final String MODEL_DONE_ATTRIBUTE = "done"; - public static final int JSON_INDENT_FACTOR = 4; - - private String title; - private String name; - private String message; - private String json; - private StackTraceElement[] stackTrace; - private Iterable diff; - - - /** - * Creates default DoneExample object. This method initializes title and - * name members by the same value. - * @param title the title text - * @return created instance of this class - */ - public static DoneExample createDefault(String title) { - return new DoneExample() - .withTitle(title) - .withName(title); - } - - /** - * Creates a JSON text from the object and applies it to member - * @param object the object to convert to JSON string - * @return this object - */ - public DoneExample withJsonObject(Object object) { - if (object != null) { - JSONObject jsonObject = new JSONObject(object); - json = jsonObject.toString(JSON_INDENT_FACTOR); - } - return this; - } - - /** - * Adds this object to model map using name 'done' - * @param model the model object to add - */ - public void addToModel(ModelMap model) { - model.addAttribute(MODEL_DONE_ATTRIBUTE, this); - } -} diff --git a/src/main/java/com/docusign/security/OAuthProperties.java b/src/main/java/com/docusign/security/OAuthProperties.java deleted file mode 100644 index 0f8b0d77..00000000 --- a/src/main/java/com/docusign/security/OAuthProperties.java +++ /dev/null @@ -1,16 +0,0 @@ -package com.docusign.security; - -import lombok.Getter; -import lombok.Setter; -import org.springframework.boot.autoconfigure.security.oauth2.client.OAuth2SsoProperties; - -@Getter -@Setter -public class OAuthProperties extends OAuth2SsoProperties { - - private String redirectUrl; - - public String getLoginPath() { - return super.getLoginPath() + redirectUrl; - } -} diff --git a/src/main/java/com/docusign/security/jwt/JWTAuthorizationCodeResourceDetails.java b/src/main/java/com/docusign/security/jwt/JWTAuthorizationCodeResourceDetails.java deleted file mode 100644 index 541c0a53..00000000 --- a/src/main/java/com/docusign/security/jwt/JWTAuthorizationCodeResourceDetails.java +++ /dev/null @@ -1,37 +0,0 @@ -package com.docusign.security.jwt; - -import com.docusign.esign.client.ApiClient; -import com.docusign.exception.LauncherException; -import java.io.IOException; -import lombok.Getter; -import lombok.Setter; -import org.springframework.core.io.FileSystemResource; -import org.springframework.security.oauth2.client.token.grant.redirect.AbstractRedirectResourceDetails; -import org.springframework.util.FileCopyUtils; - -@Getter -@Setter -public class JWTAuthorizationCodeResourceDetails extends AbstractRedirectResourceDetails { - - private String privateKeyPath; - private String impersonatedUserGuid; - private String baseUrl; - - private FileSystemResource rsaPrivateKey; - private final ApiClient apiClient = new ApiClient(); - - public byte[] getRsaBytes() throws LauncherException { - if (rsaPrivateKey == null) { - rsaPrivateKey = new FileSystemResource(privateKeyPath); - } - try { - return FileCopyUtils.copyToByteArray(rsaPrivateKey.getInputStream()); - } catch (IOException e) { - throw new LauncherException("Error reading rsa file. Check configuration"); - } - } - - public ApiClient getApiClient() { - return apiClient; - } -} diff --git a/src/main/java/com/docusign/security/jwt/JWTOAuth2RestTemplate.java b/src/main/java/com/docusign/security/jwt/JWTOAuth2RestTemplate.java deleted file mode 100644 index a0dd6793..00000000 --- a/src/main/java/com/docusign/security/jwt/JWTOAuth2RestTemplate.java +++ /dev/null @@ -1,88 +0,0 @@ -package com.docusign.security.jwt; - -import com.docusign.esign.client.ApiClient; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.client.auth.OAuth; -import com.docusign.esign.client.auth.OAuth.OAuthToken; -import com.docusign.exception.LauncherException; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Date; -import java.util.List; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.security.oauth2.client.OAuth2ClientContext; -import org.springframework.security.oauth2.client.OAuth2RestTemplate; -import org.springframework.security.oauth2.client.http.AccessTokenRequiredException; -import org.springframework.security.oauth2.client.resource.UserRedirectRequiredException; -import org.springframework.security.oauth2.common.DefaultOAuth2AccessToken; -import org.springframework.security.oauth2.common.OAuth2AccessToken; - -public class JWTOAuth2RestTemplate extends OAuth2RestTemplate { - - private static final Logger logger = LoggerFactory.getLogger(JWTOAuth2RestTemplate.class); - private static final long TOKEN_EXPIRATION_IN_SECONDS = 3600; - - private final JWTAuthorizationCodeResourceDetails resource; - private final OAuth2ClientContext context; - private ApiClient apiClient; - - public JWTOAuth2RestTemplate(JWTAuthorizationCodeResourceDetails resource, OAuth2ClientContext context) { - super(resource, context); - this.resource = resource; - this.context = context; - apiClient = resource.getApiClient(); - } - - @Override - public OAuth2AccessToken getAccessToken() throws UserRedirectRequiredException { - OAuth2AccessToken accessToken = context.getAccessToken(); - - if (accessToken == null || accessToken.isExpired()) { - try { - accessToken = accessToken(); - context.setAccessToken(accessToken); - } catch (Exception e) { - context.setAccessToken(null); - throw e; - } - } - return accessToken; - } - - private OAuth2AccessToken accessToken() { - logger.info("Fetching an access token via JWT grant..."); - List scopes = new ArrayList<>(); - // Only signature scope is needed. Impersonation scope is implied. - scopes.add(OAuth.Scope_SIGNATURE); - byte[] privateKeyBytes; - try { - privateKeyBytes = resource.getRsaBytes(); - } catch (LauncherException e) { - throw new AccessTokenRequiredException(e.getMessage(), resource); - } - apiClient.setOAuthBasePath(resource.getBaseUrl()); - OAuthToken oAuthToken; - try { - oAuthToken = apiClient.requestJWTUserToken( - resource.getClientId(), - resource.getImpersonatedUserGuid(), - scopes, - privateKeyBytes, - TOKEN_EXPIRATION_IN_SECONDS); - } catch (IOException | ApiException e) { - throw new AccessTokenRequiredException(e.getMessage(), resource); - } - apiClient.setAccessToken(oAuthToken.getAccessToken(), oAuthToken.getExpiresIn()); - logger.info("Done. Continuing..."); - return convert(oAuthToken); - } - - private static OAuth2AccessToken convert(OAuthToken oAuthToken) { - DefaultOAuth2AccessToken accessToken = new DefaultOAuth2AccessToken(oAuthToken.getAccessToken()); - accessToken.setExpiration(new Date(System.currentTimeMillis() + (oAuthToken.getExpiresIn() * 1000))); - accessToken.setTokenType(oAuthToken.getTokenType()); - return accessToken; - } - -} diff --git a/src/main/java/com/docusign/security/jwt/JWTUserInfoTokenService.java b/src/main/java/com/docusign/security/jwt/JWTUserInfoTokenService.java deleted file mode 100644 index dc684c72..00000000 --- a/src/main/java/com/docusign/security/jwt/JWTUserInfoTokenService.java +++ /dev/null @@ -1,67 +0,0 @@ -package com.docusign.security.jwt; - -import com.docusign.esign.client.ApiClient; -import com.docusign.esign.client.ApiException; -import com.docusign.esign.client.auth.OAuth.Account; -import com.docusign.esign.client.auth.OAuth.UserInfo; -import com.docusign.utils.AccountsConverter; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; -import java.util.stream.Collectors; -import org.springframework.security.authentication.AuthenticationServiceException; -import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; -import org.springframework.security.core.AuthenticationException; -import org.springframework.security.core.GrantedAuthority; -import org.springframework.security.core.authority.AuthorityUtils; -import org.springframework.security.oauth2.common.OAuth2AccessToken; -import org.springframework.security.oauth2.common.exceptions.InvalidTokenException; -import org.springframework.security.oauth2.provider.OAuth2Authentication; -import org.springframework.security.oauth2.provider.OAuth2Request; -import org.springframework.security.oauth2.provider.token.ResourceServerTokenServices; - -public class JWTUserInfoTokenService implements ResourceServerTokenServices { - - private static final String AUTHORITIES = "ROLE_USER"; - - private final JWTAuthorizationCodeResourceDetails resource; - private ApiClient apiClient; - - public JWTUserInfoTokenService(JWTAuthorizationCodeResourceDetails resource) { - this.resource = resource; - apiClient = resource.getApiClient(); - } - - @Override - public OAuth2Authentication loadAuthentication(String accessToken) throws AuthenticationException, InvalidTokenException { - UserInfo userInfo; - try { - userInfo = apiClient.getUserInfo(apiClient.getAccessToken()); - } catch (ApiException e) { - throw new AuthenticationServiceException("Cannot authenticate", e); - } - return convert(userInfo, resource.getClientId()); - } - - @Override - public OAuth2AccessToken readAccessToken(String accessToken) { - throw new UnsupportedOperationException("Not supported: read access token"); - } - - private static OAuth2Authentication convert(UserInfo userInfo, String clientId) { - List accounts = userInfo.getAccounts(); - Object principal = userInfo.getName() == null ? "unknown" : userInfo.getName(); - List authorities = AuthorityUtils.commaSeparatedStringToAuthorityList(AUTHORITIES); - OAuth2Request request = new OAuth2Request(null, clientId, null, true, null, - null, null, null, null); - UsernamePasswordAuthenticationToken token = new UsernamePasswordAuthenticationToken( - principal, "N/A", authorities); - Map details = new LinkedHashMap<>(); - List> accountsAsMap = accounts.stream() - .map(AccountsConverter::convert) - .collect(Collectors.toList()); - details.put("accounts", accountsAsMap); - token.setDetails(details); - return new OAuth2Authentication(request, token); - } -} diff --git a/src/main/resources/META-INF/spring.factories b/src/main/resources/META-INF/spring.factories new file mode 100644 index 00000000..6886d440 --- /dev/null +++ b/src/main/resources/META-INF/spring.factories @@ -0,0 +1,2 @@ +org.springframework.boot.env.PropertySourceLoader=\ +com.docusign.JsonPropertySourceLoader \ No newline at end of file diff --git a/src/main/resources/Offer_Letter_Demo.docx b/src/main/resources/Offer_Letter_Demo.docx new file mode 100644 index 00000000..a8d6d59f Binary files /dev/null and b/src/main/resources/Offer_Letter_Demo.docx differ diff --git a/src/main/resources/TermsOfService.pdf b/src/main/resources/TermsOfService.pdf new file mode 100644 index 00000000..cbecb52e Binary files /dev/null and b/src/main/resources/TermsOfService.pdf differ diff --git a/src/main/resources/Welcome.txt b/src/main/resources/Welcome.txt new file mode 100644 index 00000000..797f3bda --- /dev/null +++ b/src/main/resources/Welcome.txt @@ -0,0 +1,11 @@ + + + + + Welcome to the DocuSign Recruiting Event + + + Please Sign in! + + + \ No newline at end of file diff --git a/src/main/resources/Welcome1.txt b/src/main/resources/Welcome1.txt new file mode 100644 index 00000000..642eb799 --- /dev/null +++ b/src/main/resources/Welcome1.txt @@ -0,0 +1,3 @@ +Thanks for reviewing this! + +We'll move forward as soon as we hear back. \ No newline at end of file diff --git a/src/main/resources/application.example.json b/src/main/resources/application.example.json new file mode 100644 index 00000000..9368af32 --- /dev/null +++ b/src/main/resources/application.example.json @@ -0,0 +1,77 @@ +{ + "quickstart" :"{QUICKSTART_VALUE}", + "quickACG": "{QUICK_ACG_VALUE}", + "DS_SIGNER_NAME": "{SIGNER_NAME}", + "DS_SIGNER_EMAIL": "{SIGNER_EMAIL}", + "DS_APP_URL": "http://localhost:8080", + "DS_TARGET_ACCOUNT_ID": "{DS_TARGET_ACCOUNT_ID}", + "DS_BASE_PATH": "https://demo.docusign.net", + "DS_ROOMS_BASE_PATH": "https://demo.rooms.docusign.com", + "DS_CLICK_BASE_PATH": "https://demo.docusign.net", + "DS_MONITOR_BASE_PATH": "https://lens-d.docusign.net", + "DS_ADMIN_BASE_PATH": "https://api-d.docusign.net", + + "Gateway_Name": "{DS_PAYMENT_GATEWAY_NAME}", + "Gateway_Account_Id": "{GATEWAY_ACCOUNT_ID}", + "Gateway_Display_Name": "{DS_PAYMENT_GATEWAY_DISPLAY_NAME}", + + "authorization.code.grant.sso.redirect-url": "/oauth2/authorization/acg", + "jwt.grant.sso.redirect-url": "/oauth2/authorization/jwt", + "jwt.grant.client.base-url": "account-d.docusign.com", + "spring": { + "security": { + "oauth2": { + "client": { + "registration": { + "acg": { + "client-id": "{INTEGRATION_KEY_AUTH_CODE}", + "client-secret": "{SECRET_KEY}", + "client-authentication-method": "client_secret_basic", + "authorization-grant-type": "authorization_code", + "redirect-uri": "{baseUrl}/login/oauth2/code/acg", + "scope": "user_write, signature, impersonation, group_read, organization_read, permission_read, user_read, account_read, domain_read, identity_provider_read, user_data_redact, click.manage, click.send, dtr.rooms.read, dtr.rooms.write, dtr.documents.read, dtr.documents.write, dtr.profile.read, dtr.profile.write, dtr.company.read, dtr.company.write, room_forms, asset_group_account_read, asset_group_account_clone_write, asset_group_account_clone_read" + }, + "jwt": { + "client-id": "{INTEGRATION_KEY_JWT}", + "impersonated-user-guid": "{IMPERSONATED_USER_ID}", + "private-key-path": "src/main/resources/private.key", + "authorization-grant-type": "authorization_code", + "redirect-uri": "{baseUrl}/login/oauth2/code/jwt" + } + }, + "provider": { + "acg": { + "authorization-uri": "https://account-d.docusign.com/oauth/auth?prompt=login", + "token-uri": "https://account-d.docusign.com/oauth/token", + "user-info-uri": "https://account-d.docusign.com/oauth/userinfo", + "user-name-attribute": "sub" + }, + "jwt": { + "authorization-uri": "https://account-d.docusign.com/oauth/auth?prompt=login", + "token-uri": "https://account-d.docusign.com/oauth/token", + "user-info-uri": "https://account-d.docusign.com/oauth/userinfo", + "user-name-attribute": "sub" + } + } + } + } + } + }, + + "common.client.resource.user-info-uri": "https://account-d.docusign.com/oauth/userinfo", + "com.docusign.github.example-uri": "https://github.com/docusign/code-examples-java/blob/master/src/main/java/", + "com.docusign.documentation-path": "", + + "CodeExamplesManifest": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/CodeExamplesManifest.json", + + "server.tomcat.additional-tld-skip-patterns": "*jaxb*.jar", + "server.servlet.session.tracking-modes": "cookie", + "server.servlet.session.persistent": false, + "server.error.include-stacktrace": "always", + "server.error.whitelabel.enabled": false, + + "spring.session.store-type": "none", + "spring.mvc.view.prefix": "/WEB-INF/templates/views/", + "spring.mvc.view.suffix": ".jsp", + "spring.jmx.enabled": false +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties deleted file mode 100644 index e8834828..00000000 --- a/src/main/resources/application.properties +++ /dev/null @@ -1,51 +0,0 @@ -DS_SIGNER_EMAIL={SIGNER_EMAIL} -DS_SIGNER_NAME={SIGNER_NAME} -# Set if you want a specific DocuSign AccountId, If null, the user's default account will be used. -DS_TARGET_ACCOUNT_ID={IMPERSONATED_USER_GUID} -# The client id (Integrator Key) must include a Redirect URI of /login appended -# to the DS_APP_URL. Eg http://localhost:8080/login -DS_APP_URL=http://localhost:8080 - -# Optional settings for a payment gateway -Gateway_Account_Id={DS_PAYMENT_GATEWAY_ID} -Gateway_Name={DS_PAYMENT_GATEWAY_NAME} -Gateway_Display_Name={DS_PAYMENT_GATEWAY_DISPLAY_NAME} - -spring.jmx.enabled=false -# this option is needed for preventing annoying warning related to missing JAXB -# dependecies which had been excluded from the Java 11 -server.tomcat.additional-tld-skip-patterns=*jaxb*.jar - -server.servlet.session.tracking-modes=cookie -server.servlet.session.persistent=false -spring.session.store-type=none -server.error.whitelabel.enabled=false -server.error.include-stacktrace=always - -spring.mvc.view.prefix=/WEB-INF/templates/views/ -spring.mvc.view.suffix=.jsp - -# location of the source code of examples -com.docusign.github.example-uri=https://github.com/docusign/eg-03-java-auth-code-grant/blob/master/src/main/java/ -com.docusign.documentation-path= - -#JWT Grant client: -jwt.grant.client.client-id={JWT_API_ACCOUNT_ID} -jwt.grant.client.impersonated-user-guid={JWT_USER_IMPERSONATED_GUID} -jwt.grant.client.base-url=account-d.docusign.com -jwt.grant.client.scope=signature impersonation -jwt.grant.client.private-key-path=src/main/resources/private.key -#To distinguish authentication. Add to redirect urls -jwt.grant.sso.redirect-url=&type=jwt - -#Authorization Code Grant (acg) client: -authorization.code.grant.client.client-id={INTEGRATION_ID} -authorization.code.grant.client.client-secret={INTEGRATION_SECRET} -authorization.code.grant.client.user-authorization-uri=https://account-d.docusign.com/oauth/auth?prompt=login -authorization.code.grant.client.access-token-uri=https://account-d.docusign.com/oauth/token -authorization.code.grant.client.scope=signature -#To distinguish authentication. Add to redirect urls -authorization.code.grant.sso.redirect-url=&type=acg - -#User info -common.client.resource.user-info-uri=https://account-d.docusign.com/oauth/userinfo diff --git a/src/main/resources/applicationJsonMissingError.html b/src/main/resources/applicationJsonMissingError.html new file mode 100644 index 00000000..1fe0e9bd --- /dev/null +++ b/src/main/resources/applicationJsonMissingError.html @@ -0,0 +1,74 @@ + + + + + + + + + + Error finding the application.json file + + + + + + + + + + + + + + +
+
+

Problem: an error occurred

+ +

Error information:

+

Message: While trying to launch the code examples, the application.json file could not been found.

+

Please, create the file and fill it in using the + template, then restart a launcher.

+
+
+ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/main/resources/doc_1.html b/src/main/resources/doc_1.html new file mode 100644 index 00000000..be6ec517 --- /dev/null +++ b/src/main/resources/doc_1.html @@ -0,0 +1,20 @@ + + + + + + +

World Wide Corp

+

Order Processing Division

+

Ordered by {USER_FULLNAME}

+

Email: {USER_EMAIL}

+

+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. +

+ +

Agreed: **signature_1**/

+ + diff --git a/src/main/resources/order_form.html b/src/main/resources/order_form.html index cddf3704..15b87ddb 100644 --- a/src/main/resources/order_form.html +++ b/src/main/resources/order_form.html @@ -29,7 +29,7 @@

Ordered by {signerName}

Harmonica - /l1q/ + /l1q/ $5 @@ -39,7 +39,7 @@

Ordered by {signerName}

Xylophone - /l2q/ + /l2q/ $150 diff --git a/src/main/resources/public/assets/banner-code.png b/src/main/resources/public/assets/banner-code.png new file mode 100644 index 00000000..292d14e9 Binary files /dev/null and b/src/main/resources/public/assets/banner-code.png differ diff --git a/src/main/resources/public/assets/css.css b/src/main/resources/public/assets/css.css index 40080201..5518c422 100644 --- a/src/main/resources/public/assets/css.css +++ b/src/main/resources/public/assets/css.css @@ -8,31 +8,49 @@ body { } #index-page h4::before { z-index: -100; - display: block; - content: " "; - margin-top: -4rem; - height: 4rem; - visibility: hidden; + display: block; + content: " "; + margin-top: -4rem; + height: 4rem; + visibility: hidden; pointer-events: none; } .jumbotron { - background: #888888; - padding: 3em; + + background: #000 !important; + padding-top: 0 !important; + padding-bottom: 0 !important; + padding-left: 30px !important; + padding-right: 30px !important; + margin: 0 !important; color: white; - margin: 1em auto 1.5em; } +} .jumbotron p { margin-top: 1em; font-size: 1.45em; } +.btn-docu { + + background-color: #00BAA1; + color:#FFF; + border-color: #121517; +} + +.btn-docu:hover, .btn-docu:focus, .btn-docu:active, .btn-docu.active, .open .dropdown-toggle.btn-docu { + background-color: #02d6ba; + color:#FFF; + border-color: #050607; +} + hr.styled { overflow: visible; /* For IE */ padding: 0; border: none; - border-top: medium double #333; - color: #333; + border-top: medium double 0; + color: #000; text-align: center; } hr.styled:after { @@ -45,7 +63,6 @@ hr.styled:after { background: white; } - .feedback, .hidden {display: none;} span.feedback {margin-left:2em;} @@ -56,27 +73,18 @@ pre.json-display { background-color: ghostwhite; border: 1px solid silver; padding: 10px 20px; - } +} .json-key { color: brown; - } +} .json-value { color: navy; - } +} .json-string { color: olive; - } - -table, th, td { - background-color: #f4f4fb; - padding-left: 7px; - padding-right: 7px; - caption-side: top; } -th { - border-bottom: 1px solid black; -} + /* From http://tobiasahlin.com/spinkit/ */ @@ -125,10 +133,31 @@ th { @keyframes sk-stretchdelay { 0%, 40%, 100% { - transform: scaleY(0.4); - -webkit-transform: scaleY(0.4); + transform: scaleY(0.4); + -webkit-transform: scaleY(0.4); } 20% { - transform: scaleY(1.0); - -webkit-transform: scaleY(1.0); - } + transform: scaleY(1.0); + -webkit-transform: scaleY(1.0); + } +} + +.your-class div{ +float:left; +margin-left: 10px; } + +.has-search .form-control { + padding-left: 2.375rem; +} + +.has-search .form-control-feedback { + position: absolute; + z-index: 2; + display: block; + width: 2.375rem; + height: 2.375rem; + line-height: 2.375rem; + text-align: center; + pointer-events: none; + color: #aaa; +} \ No newline at end of file diff --git a/src/main/resources/public/assets/favicon.ico b/src/main/resources/public/assets/favicon.ico index b3b2dc49..fd990b69 100644 Binary files a/src/main/resources/public/assets/favicon.ico and b/src/main/resources/public/assets/favicon.ico differ diff --git a/src/main/resources/public/assets/search.js b/src/main/resources/public/assets/search.js new file mode 100644 index 00000000..0ab7e98b --- /dev/null +++ b/src/main/resources/public/assets/search.js @@ -0,0 +1,266 @@ +let DS_SEARCH = (function () { + const API_TYPES = { + ESIGNATURE: 'esignature', + MONITOR: 'monitor', + CLICK: 'click', + ROOMS: 'rooms', + ADMIN: 'admin', + CONNECT: 'connect' + }; + + let processJSONData = function () { + let json_raw = $("#api_json_data").text() + , json = json_raw ? JSON.parse(json_raw) : false; + + return json; + } + + let processCFR11Value = function () { + let json_raw = $("#cfr11_data").text(); + + return json_raw; + } + + function checkIfExampleMatches(example, matches) { + const name = example.ExampleName; + const description = example.ExampleDescription; + const pathNames = example.LinksToAPIMethod?.map(a => a.PathName); + + for (let i = 0; i < matches.length; i++) { + if (name === matches[i].value || description === matches[i].value || pathNames.indexOf(matches[i].value) > -1) { + return true; + } + } + + return false; + } + + function clearNonMatchingExamples(examples, matches) { + for (let i = examples.length - 1; i >= 0; i--) { + if (!checkIfExampleMatches(examples[i], matches)) { + examples.splice(i, 1); + } + } + } + + function clearResultsAfterMatching(api, matches) { + const groups = api.Groups; + + for (let i = groups.length - 1; i >= 0; i--) { + const group = groups[i]; + clearNonMatchingExamples(group.Examples, matches); + + if (group.Examples.length === 0) { + groups.splice(i, 1); + } + } + } + + let findCodeExamplesByKeywords = function (json, pattern) { + const options = { + isCaseSensitive: false, + threshold: -0.0, + includeMatches: true, + ignoreLocation: true, + useExtendedSearch: true, + keys: [ + "Groups.Examples.ExampleName", + "Groups.Examples.ExampleDescription", + "Groups.Examples.LinksToAPIMethod.PathName" + ] + }; + + let clearJSON = JSON.stringify(json).replace(/<\/?[^>]+(>|$)/g, ""); + const fuse = new Fuse(JSON.parse(clearJSON), options); + + var searchResults = fuse.search(JSON.stringify(pattern)); + + + + searchResults.forEach(searchResult => { + return clearResultsAfterMatching(searchResult.item, searchResult.matches) + }); + + return searchResults; + } + + let getExamplesByAPIType = function (apiType, codeExamples) { + let codeExamplesByAPI = codeExamples.find(x => x.Name.toLowerCase() === apiType); + + if (codeExamplesByAPI != null) { + return [codeExamplesByAPI]; + } else { + return null; + } + } + + let getEnteredAPIType = function (inputValue) { + const inputLength = inputValue.length; + + for (const key in API_TYPES) { + if (Object.hasOwnProperty.call(API_TYPES, key)) { + const apiType = API_TYPES[key]; + const comparedValue = apiType.substr(0, inputLength); + + if (inputValue === comparedValue) { + return apiType; + } + } + } + + return null; + } + + function getLinkForApiType(apiName) { + switch (apiName) { + case API_TYPES.ADMIN: + return "a"; + case API_TYPES.CLICK: + return "c"; + case API_TYPES.ROOMS: + return "r"; + case API_TYPES.MONITOR: + return "m"; + case API_TYPES.ESIGNATURE: + return "eg"; + case API_TYPES.CONNECT: + return "con"; + } + } + + let addCodeExampleToHomepage = function (codeExamples) { + var cfrPart11 = processCFR11Value(); + + codeExamples.forEach( + element => { + let linkToCodeExample = getLinkForApiType(element.Name.toLowerCase()); + + element.Groups.forEach( + group => { + $("#filtered_code_examples").append("

" + group.Name + "

"); + + group.Examples.forEach( + example => { + if (!example.SkipForLanguages || !example.SkipForLanguages.toLowerCase().includes("c#")) { + if (element.Name.toLowerCase() !== API_TYPES.ESIGNATURE.toLowerCase() || + ((example.CFREnabled == "AllAccounts") || + ((cfrPart11 == "True") && (example.CFREnabled == "CFROnly")) || + ((cfrPart11 != "True") && (example.CFREnabled == "NonCFR")))) { + $("#filtered_code_examples").append( + "

" + + "" + + example.ExampleName + + "

" + ); + + $("#filtered_code_examples").append("

" + example.ExampleDescription + "

"); + + $("#filtered_code_examples").append("

"); + if (example.LinksToAPIMethod != undefined && example.LinksToAPIMethod?.length !== 0) { + if (example.LinksToAPIMethod.length == 1) { + $("#filtered_code_examples").append(processJSONData().SupportingTexts.APIMethodUsed); + } + else { + $("#filtered_code_examples").append(processJSONData().SupportingTexts.APIMethodUsedPlural); + } + + for (let index = 0; index < example.LinksToAPIMethod.length; index++) { + $("#filtered_code_examples").append( + " " + + example.LinksToAPIMethod[index].PathName + + "" + ); + + if (index + 1 === example.LinksToAPIMethod.length) { + $("#filtered_code_examples").append(""); + } + else if (index + 1 === example.LinksToAPIMethod.length - 1) { + $("#filtered_code_examples").append(" and "); + } + else { + $("#filtered_code_examples").append(", "); + } + + } + } + + $("#filtered_code_examples").append("

"); + } + } + } + ); + } + ); + } + ); + } + + let textCouldNotBeFound = function () { + $("#filtered_code_examples").append(processJSONData().SupportingTexts.SearchFailed); + } + + return { + processJSONData: processJSONData, + getEnteredAPIType: getEnteredAPIType, + getExamplesByAPIType: getExamplesByAPIType, + findCodeExamplesByKeywords: findCodeExamplesByKeywords, + textCouldNotBeFound: textCouldNotBeFound, + addCodeExampleToHomepage: addCodeExampleToHomepage + } +})(); + +const input = document.getElementById('code_example_search'); +const log = document.getElementById('values'); + +input.addEventListener('input', updateValue); + +function updateValue(esearchPattern) { + document.getElementById('filtered_code_examples').innerHTML = ""; + + const inputValue = esearchPattern.target.value.toLowerCase(); + const json = DS_SEARCH.processJSONData().APIs; + + if (inputValue === "") { + DS_SEARCH.addCodeExampleToHomepage(json); + } + else { + const apiType = DS_SEARCH.getEnteredAPIType(inputValue); + + if (apiType !== null) { + const adminExamples = DS_SEARCH.getExamplesByAPIType(apiType, json); + DS_SEARCH.addCodeExampleToHomepage(adminExamples); + } + else { + const result = DS_SEARCH.findCodeExamplesByKeywords(json, inputValue); + if (result.length < 1) { + DS_SEARCH.textCouldNotBeFound(); + } else { + result.forEach(x => { + var api = json.filter(api => { + return api.Name === x.item.Name; + })[0]; + + x.item.Groups.forEach((group, groupIndex) => { + var unfilteredGroup = api.Groups.filter(apiGroup => { + return apiGroup.Name === group.Name; + })[0]; + + group.Examples.forEach((example, index) => { + var clearedExample = unfilteredGroup.Examples.filter(apiExample => { + return apiExample.ExampleNumber === example.ExampleNumber; + })[0]; + x.item.Groups[groupIndex].Examples[index] = clearedExample; + }); + }); + + DS_SEARCH.addCodeExampleToHomepage([x.item]); + }); + } + } + } +} diff --git a/src/main/resources/public/assets/site.js b/src/main/resources/public/assets/site.js new file mode 100644 index 00000000..87a53af5 --- /dev/null +++ b/src/main/resources/public/assets/site.js @@ -0,0 +1,23 @@ +$(document).ready(function () { + $("#Products").on("change", function () { + $list = $("#PermissionProfilesFiltered"); + $.ajax({ + url: "/a008/getPermissionProfiles", + type: "GET", + data: { productId: $("#Products").val() }, + traditional: true, + dataType: "json", + success: function (result) { + console.log(result) + $list.empty(); + $.each(result, function (i, item) { + console.log(item) + $list.append(''); + }); + }, + error: function () { + console.warn("Issues with calling the getPermissionProfiles endpoint. Please, check the solution."); + } + }); + }); +}); diff --git a/src/main/webapp/WEB-INF/templates/views/error.jsp b/src/main/webapp/WEB-INF/templates/views/error.jsp index 49417655..94ccf560 100644 --- a/src/main/webapp/WEB-INF/templates/views/error.jsp +++ b/src/main/webapp/WEB-INF/templates/views/error.jsp @@ -1,16 +1,30 @@ <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> +<%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %> -

${done.title}. ${done.name}

-

The example "${done.name}" is failed. Error information:

-

Message:
${done.message}

-

Stack trace:

-
    - -
  • ${item.className}.${item.methodName}(${item.fileName}:${item.lineNumber})
    • -     -
+<%-- Used for consent redirect sequence --%> + + +<%-- using ' ' instead of ':' to prevent issue with delimiter and redirect url --%> + + -

Continue

+ + +

Problem: an error occurred

+ +

Error information:

+

Message: ${done.message}

+

${done.fixingInstructions}

+ + +

Oops, we have encountered a problem.

+

Message: ${done.message}

+

Dump: ${done.stackTracePrinted}

+ +

Please check your account configuration. If you are unable to resolve the problem, open a new issue on GitHub.

+ + +

${launcherTexts.getContinueButton()}

diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a001.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a001.jsp new file mode 100644 index 00000000..ec589a8d --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a001.jsp @@ -0,0 +1,109 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + + + + + + + + +

1. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+ +
+ + + +
+ +
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a002.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a002.jsp new file mode 100644 index 00000000..4084edf7 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a002.jsp @@ -0,0 +1,137 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + + + + + + + + + +

2. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example. +

+ + + + + +

+ ${viewSourceFile} +

+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+ +
+ + + +
+ +
+ + + +
+ + +
+ + + +
+ + + + +
+ + +
+
+ + +
+
+
+
+ \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a003.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a003.jsp new file mode 100644 index 00000000..ef35411f --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a003.jsp @@ -0,0 +1,21 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + +

3. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a003a.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a003a.jsp new file mode 100644 index 00000000..f198d1b9 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a003a.jsp @@ -0,0 +1,31 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + +

3a. ${example.getExampleName()}

+

${example.getAdditionalPage().get(0).getResultsPageText()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + + +
+ + +
+ + +

+ Problem: please first bulk export user data using Send an envelope with a remote (email) signer and cc recipient..
+ Thank you. +

+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a004.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a004.jsp new file mode 100644 index 00000000..4932f958 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a004.jsp @@ -0,0 +1,21 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + +

4. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a004a.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a004a.jsp new file mode 100644 index 00000000..a16c293d --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a004a.jsp @@ -0,0 +1,31 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + +

4a. ${example.getExampleName()}

+

${example.getAdditionalPage().get(0).getResultsPageText()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + + +
+ + +
+ + +

+ Problem: please first bulk import user data example 4.
+ Thank you. +

+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a005.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a005.jsp new file mode 100644 index 00000000..c2e8cc10 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a005.jsp @@ -0,0 +1,24 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + +

5. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ + + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a006.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a006.jsp new file mode 100644 index 00000000..c7cc375f --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a006.jsp @@ -0,0 +1,40 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + + + +

6. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + + +
+ + +
+
diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a007.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a007.jsp new file mode 100644 index 00000000..d2c18597 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a007.jsp @@ -0,0 +1,38 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + + + +

7. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + +
+ + +
+
diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a008.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a008.jsp new file mode 100644 index 00000000..48cb4fcc --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a008.jsp @@ -0,0 +1,67 @@ +<%@ page import="com.docusign.core.model.manifestModels.CodeExampleText" %> +<%@ page import="java.util.Arrays" %> +<%@ page import="com.docusign.core.model.manifestModels.RedirectsToOtherCodeExamples" %> +<%@ page import="java.util.ArrayList" %> +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + + + + + + +

8. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + + +

${example.getForms().get(formNumber).getFormName().replaceFirst("\\{0}", emailAddress)}

+ +
+
+ + + +
+ +
+ + + +
+ + + +
+ + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToSecondCodeExample)} +

+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a009.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a009.jsp new file mode 100644 index 00000000..1cba8d96 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a009.jsp @@ -0,0 +1,50 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + + + + + +

9. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + + +

${example.getForms().get(formNumber).getFormName().replaceFirst("\\{0}", emailAddress)}

+ +
+
+ + + +
+ + + +
+ + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToSecondCodeExample)} +

+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a010.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a010.jsp new file mode 100644 index 00000000..1c10750f --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a010.jsp @@ -0,0 +1,39 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + + + +

10. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailAddressOfUserToDelete()} + +
+ + + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a011.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a011.jsp new file mode 100644 index 00000000..c8d1f037 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a011.jsp @@ -0,0 +1,40 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + + + +

11. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getUserIDOfUserToDelete()} + +
+ + + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a012.jsp b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a012.jsp new file mode 100644 index 00000000..83e2a7fa --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/admin/examples/a012.jsp @@ -0,0 +1,94 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + + + + + + + + +

12. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c001.jsp b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c001.jsp new file mode 100644 index 00000000..4ae83857 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c001.jsp @@ -0,0 +1,31 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

+ ${viewSourceFile} +

+ +
+
+ + + +
+ + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c002.jsp b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c002.jsp new file mode 100644 index 00000000..8531398a --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c002.jsp @@ -0,0 +1,43 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

+ ${viewSourceFile} +

+ + + +

${example.getForms().get(formNumber).getFormName()}

+
+
+ + + +
+ + +
+ + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToFirstCodeExample)} +

+ + + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c003.jsp b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c003.jsp new file mode 100644 index 00000000..32aa9e0d --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c003.jsp @@ -0,0 +1,53 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

+ ${viewSourceFile} +

+ + + +
+
+ + + +
+
+ + + +
+ + +
+ + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToFirstCodeExample)} +

+ + + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c004.jsp b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c004.jsp new file mode 100644 index 00000000..9e7e2561 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c004.jsp @@ -0,0 +1,19 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

+ ${viewSourceFile} +

+ + +
+ + +
+ + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c005.jsp b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c005.jsp new file mode 100644 index 00000000..12090083 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c005.jsp @@ -0,0 +1,44 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

+ ${viewSourceFile} +

+ + + +

${example.getForms().get(formNumber).getFormName()}

+
+
+ + + +
+ + +
+ + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToFirstCodeExample)} +

+ + + + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c006.jsp b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c006.jsp new file mode 100644 index 00000000..d150a654 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/click/examples/c006.jsp @@ -0,0 +1,114 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

+ ${viewSourceFile} +

+ + + +

${example.getForms().get(formNumber).getFormName()}

+
+
+ + + +
+
+ + + +
+
+ + + +
+
+ + + +
+
+ + + +
+
+ + + +
+ + +
+ + + + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumberTo2).getRedirectText().replaceFirst("\\{0}", redirectToSecondCodeExample)} +

+ + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumberTo1).getRedirectText().replaceFirst("\\{0}", redirectToFirstCodeExample)} +

+ + + + + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/connect/examples/con001.jsp b/src/main/webapp/WEB-INF/templates/views/pages/connect/examples/con001.jsp new file mode 100644 index 00000000..bfa8aa83 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/connect/examples/con001.jsp @@ -0,0 +1,52 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +

+ Prerequisites: See How to validate a webhook message using HMAC. +

+ +
+
+ + + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/ds_must_authenticate.jsp b/src/main/webapp/WEB-INF/templates/views/pages/ds_must_authenticate.jsp index aa857c4b..5e210c05 100644 --- a/src/main/webapp/WEB-INF/templates/views/pages/ds_must_authenticate.jsp +++ b/src/main/webapp/WEB-INF/templates/views/pages/ds_must_authenticate.jsp @@ -1,19 +1,22 @@ - <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> -
-

Please Authenticate with DocuSign

-

Please choose your authentication type

-
+ + +
+ ${launcherTexts.getLoginPage().getLoginHeader()} + +
-

- +

+

+

+
-

You need to authenticate with DocuSign to continue your request.

+

${launcherTexts.getLoginPage().getLoginHelperText()}

diff --git a/src/main/webapp/WEB-INF/templates/views/pages/ds_restart.jsp b/src/main/webapp/WEB-INF/templates/views/pages/ds_restart.jsp new file mode 100644 index 00000000..5adae759 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/ds_restart.jsp @@ -0,0 +1,14 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + +
+
+

Please restart the app to finish switching to a new API.

+

+ Quit the current app with Control + C, then run + mvn package followed by + java -Dspring.profiles.active=dev -jar target/code-examples-java-1.0-SNAPSHOT.war + again or rerun it using the Run button in IntelliJ Ultimate or Eclipse. +

+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/ds_return.jsp b/src/main/webapp/WEB-INF/templates/views/pages/ds_return.jsp index 393bdc79..18ca65e7 100644 --- a/src/main/webapp/WEB-INF/templates/views/pages/ds_return.jsp +++ b/src/main/webapp/WEB-INF/templates/views/pages/ds_return.jsp @@ -20,6 +20,6 @@ -

Continue

+

${launcherTexts.getContinueButton()}

diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg001.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg001.jsp new file mode 100644 index 00000000..4f6762a4 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg001.jsp @@ -0,0 +1,56 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg002.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg002.jsp new file mode 100644 index 00000000..c91be407 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg002.jsp @@ -0,0 +1,87 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg003.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg003.jsp new file mode 100644 index 00000000..0727ba23 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg003.jsp @@ -0,0 +1,21 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg004.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg004.jsp new file mode 100644 index 00000000..80878ef4 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg004.jsp @@ -0,0 +1,43 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ + + +

+ ${example.getForms().get(formNumber).getFormName()} +

+ +
+ + +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToSecondCodeExample)}

+ +
+ +
+ + + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg005.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg005.jsp new file mode 100644 index 00000000..d950776f --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg005.jsp @@ -0,0 +1,42 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + + +

+ ${example.getForms().get(formNumber).getFormName()} +

+ +
+ + +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToSecondCodeExample)}

+ +
+ +
+ + + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg006.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg006.jsp new file mode 100644 index 00000000..0da48cac --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg006.jsp @@ -0,0 +1,41 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ + + +

+ ${example.getForms().get(formNumber).getFormName()} +

+ +
+ + +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToSecondCodeExample)}

+ +
+ +
+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg007.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg007.jsp new file mode 100644 index 00000000..45d14e81 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg007.jsp @@ -0,0 +1,63 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ + + +

${example.getRedirectsToOtherCodeExamples().get(redirectSecondNumber).getRedirectText().replaceFirst("\\{0}", redirectToSecondCodeExample)}

+ +
+ +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirectSixNumber).getRedirectText().replaceFirst("\\{0}", redirectToSixthCodeExample)}

+ +
+ +
+ + +

${example.getForms().get(formNumber).getFormName()}

+ +
+
+ + + +
+ + +
+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg008.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg008.jsp new file mode 100644 index 00000000..b86dbe03 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg008.jsp @@ -0,0 +1,22 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg009.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg009.jsp new file mode 100644 index 00000000..5da55c55 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg009.jsp @@ -0,0 +1,118 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + + +

${example.getForms().get(formNumber).getFormName()}

+ +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+ + + +
+ + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToEigthCodeExample)} +

+ +
+ +
+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg010.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg010.jsp new file mode 100644 index 00000000..a66a5380 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg010.jsp @@ -0,0 +1,88 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg011.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg011.jsp new file mode 100644 index 00000000..f4ceacce --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg011.jsp @@ -0,0 +1,99 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg012.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg012.jsp new file mode 100644 index 00000000..bf2cf05d --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg012.jsp @@ -0,0 +1,44 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToSecondCodeExample)}

+ + + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg013.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg013.jsp new file mode 100644 index 00000000..7d8c1864 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg013.jsp @@ -0,0 +1,140 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + + + + +

${example.getExampleName()}

+ + +

${example.getExampleDescription()}

+ + + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +

${example.getForms().get(formNumber).getFormName()}

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+

+

+

+
+ + + +
+
+ + + +
+ + +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToEigthCodeExample)}

+ +
+ +
+ + + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg014.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg014.jsp new file mode 100644 index 00000000..65114bca --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg014.jsp @@ -0,0 +1,97 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

${example.getNotes()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()}} + +
+
+ + + +
+ + +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText()}

+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg015.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg015.jsp new file mode 100644 index 00000000..3326b3e0 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg015.jsp @@ -0,0 +1,39 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + + +

${example.getForms().get(formNumber).getFormName()}

+ +
+ + +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToNinthCodeExample)}

+ +
+ +
+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg016.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg016.jsp new file mode 100644 index 00000000..3a5b7eee --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg016.jsp @@ -0,0 +1,60 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + + +
+ + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg017.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg017.jsp new file mode 100644 index 00000000..84b1b749 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg017.jsp @@ -0,0 +1,114 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + +

+ ${viewSourceFile} +

+ + + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+ + +
+ + + +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToEightCodeExample)}

+ +
+ +
+ + + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg018.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg018.jsp new file mode 100644 index 00000000..dbfbff5d --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg018.jsp @@ -0,0 +1,41 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + + +

+ ${example.getForms().get(formNumber).getFormName().replaceFirst("\\{0}", redirectTo16CodeExample)} +

+
+ + +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectTo16CodeExample)}

+ +
+ +
+ + + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg019.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg019.jsp new file mode 100644 index 00000000..cd8f573b --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg019.jsp @@ -0,0 +1,75 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getAccessCodeText()} + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg020.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg020.jsp new file mode 100644 index 00000000..6ea12093 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg020.jsp @@ -0,0 +1,89 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg022.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg022.jsp new file mode 100644 index 00000000..70957600 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg022.jsp @@ -0,0 +1,59 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

${example.getNotes()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg023.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg023.jsp new file mode 100644 index 00000000..201da42b --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg023.jsp @@ -0,0 +1,58 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

${example.getNotes()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg024.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg024.jsp new file mode 100644 index 00000000..b2c39bb4 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg024.jsp @@ -0,0 +1,39 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+
+ + + +
+ + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg025.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg025.jsp similarity index 51% rename from src/main/webapp/WEB-INF/templates/views/pages/examples/eg025.jsp rename to src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg025.jsp index 1383dad5..b656914b 100644 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg025.jsp +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg025.jsp @@ -1,30 +1,30 @@ <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - + -

25. ${title}.

+ + + -

- Permission profiles are collections of account settings that determine the behavior and actions - available to the user groups to which they're applied. This code example demonstrates how to - the permission profile for the group with the eSignature REST API. -

+

${example.getExampleName()}

+

${example.getExampleDescription()}

Documentation about this example.

 -

API method used: - Groups::update. -

+

- View source file ${sourceFile} on GitHub. + ${viewSourceFile}

- + + @@ -42,7 +45,7 @@
- +
- \ No newline at end of file + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg026.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg026.jsp new file mode 100644 index 00000000..958ff8f9 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg026.jsp @@ -0,0 +1,50 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+
+ + + +
+ + + +
+ + + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg027.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg027.jsp new file mode 100644 index 00000000..d415e620 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg027.jsp @@ -0,0 +1,39 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

${example.getNotes()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+
+ + + +
+ + + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg028.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg028.jsp new file mode 100644 index 00000000..cdd0a010 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg028.jsp @@ -0,0 +1,54 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+

+ ${example.getForms().get(formNumber).getFormName()} +

+
+ + + +
+
+ + + +
+ + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg029.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg029.jsp new file mode 100644 index 00000000..a2bd1245 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg029.jsp @@ -0,0 +1,89 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%> + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

+ Documentation about + this example. +

+ + + + +

+ ${viewSourceFile} +

+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectTo28CodeExample)} + + +
+ + +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectTo28CodeExample)}

+ +
+ +
+ + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg030.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg030.jsp new file mode 100644 index 00000000..bf15152d --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg030.jsp @@ -0,0 +1,122 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%> + + + + + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

+ Documentation about this example. +

+ + + + +

+ ${viewSourceFile} +

+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+
+ + +
+ + +
+ + + +

${example.getRedirectsToOtherCodeExamples().get(redirect8Number).getRedirectText().replaceFirst("\\{0}", redirectTo8CodeExample)}

+
+ +
+ + +

${example.getRedirectsToOtherCodeExamples().get(redirect28Number).getRedirectText().replaceFirst("\\{0}", redirectTo28CodeExample)}

+
+ +
+ + + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg031.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg031.jsp new file mode 100644 index 00000000..a13dbd41 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg031.jsp @@ -0,0 +1,150 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+
+
+
${example.getForms().get(firstFormNumber).getFormName()}
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + +
+
+ +
+
${example.getForms().get(secondFormNumber).getFormName()}
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+
+
+
+ + +
+
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg032.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg032.jsp new file mode 100644 index 00000000..85e0f506 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg032.jsp @@ -0,0 +1,96 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+

${example.getForms().get(firstFormNumber).getFormName()}

+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ +

${example.getForms().get(secondFormNumber).getFormName()}

+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg033.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg033.jsp new file mode 100644 index 00000000..3e007452 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg033.jsp @@ -0,0 +1,23 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ + +
+ + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg034.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg034.jsp new file mode 100644 index 00000000..dbcd32f7 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg034.jsp @@ -0,0 +1,124 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + +

+ ${viewSourceFile} +

+ + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ +
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ +
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg035.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg035.jsp new file mode 100644 index 00000000..4b740837 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg035.jsp @@ -0,0 +1,77 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getChooseDateInTheFuture()}} + +
+ + +
+
+
+
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg036.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg036.jsp new file mode 100644 index 00000000..995c3c13 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg036.jsp @@ -0,0 +1,105 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+
+ + + +
+ + +
+
+
+
+ + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg037.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg037.jsp new file mode 100644 index 00000000..418de37a --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg037.jsp @@ -0,0 +1,135 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+
+ ${example.getForms().get(formNumber).getInputs().get(sms).getInputName()}   + ${example.getForms().get(formNumber).getInputs().get(whatsapp).getInputName()}
+
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCountryCodeText()} + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getPhoneNumberWillBeNotified()} ${launcherTexts.getHelpingTexts().getPhoneNumberWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCountryCodeText()} + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getPhoneNumberWillBeNotified()} ${launcherTexts.getHelpingTexts().getPhoneNumberWontBeShared()} + +
+
+ + + +
+ + +
+ +
+
+
+ + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg038.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg038.jsp new file mode 100644 index 00000000..0ac3f520 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg038.jsp @@ -0,0 +1,88 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg039.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg039.jsp new file mode 100644 index 00000000..9bc998b7 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg039.jsp @@ -0,0 +1,36 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg040.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg040.jsp new file mode 100644 index 00000000..ec89d099 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg040.jsp @@ -0,0 +1,119 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ + +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCCEmailShouldDifferFromSigner()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg041.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg041.jsp new file mode 100644 index 00000000..609ba33c --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg041.jsp @@ -0,0 +1,91 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getCountryCodeText()} + +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getPhoneNumberWillBeNotified()} ${launcherTexts.getHelpingTexts().getPhoneNumberWontBeShared()} + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg042.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg042.jsp new file mode 100644 index 00000000..33acebf2 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg042.jsp @@ -0,0 +1,114 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+

+ ${example.getForms().get(formNumber).getFormName()} +

+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+ +
+ + + +
+ + + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg043.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg043.jsp new file mode 100644 index 00000000..f2f0b41d --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg043.jsp @@ -0,0 +1,72 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + +
+
+ + + +
+
+ + + + + + + ${launcherTexts.getHelpingTexts().getSaveAgentActivationCode()} + +
+ + + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg044.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg044.jsp new file mode 100644 index 00000000..4f6762a4 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg044.jsp @@ -0,0 +1,56 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/embed.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/embed.jsp new file mode 100644 index 00000000..8c5208ce --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/embed.jsp @@ -0,0 +1,84 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + +
+

The document has been embedded with focused view.

+
+ + + + + + + + Signing + + + +
+ + + +

Continue

+ + + + + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/quickEmbeddedSigning.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/quickEmbeddedSigning.jsp new file mode 100644 index 00000000..94143ee0 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/quickEmbeddedSigning.jsp @@ -0,0 +1,121 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + + + + + + + ${title} + + + + + + + + + + + + +
+ +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + +

+ + + ${launcherTexts.getAPIMethodUsed()} + + + ${launcherTexts.getAPIMethodUsedPlural()} + + + + + ${link.getPathName()} + + + + . + + + and + + + , + + + +

+ +

+ ${viewSourceFile} +

+ +
+
+ + + + + + ${launcherTexts.getHelpingTexts().getEmailWontBeShared()} + +
+
+ + + +
+ + +
+
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/esignature/index.jsp b/src/main/webapp/WEB-INF/templates/views/pages/esignature/index.jsp new file mode 100644 index 00000000..26e19e59 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/esignature/index.jsp @@ -0,0 +1,124 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + +
+
+ + + + + + +
+

Java Launcher

+

${launcherTexts.getHomePageText()}

+ 		+ +
+
+ + + +
+ +

Documentation on using OAuth Authorization Code Grant from a Java application.

+ + +
+ + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +

${group.getName()}

+ + + + +

+ + ${example.getExampleName()} + +

+ +

${example.getExampleDescription()}

+ +

+ + + + ${launcherTexts.getAPIMethodUsed()} + + + ${launcherTexts.getAPIMethodUsedPlural()} + + + + + + ${link.getPathName()} + + + + + . + + + and + + + , + + + + +

+ + + + + +
+ +
+ + + + + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/example_done.jsp b/src/main/webapp/WEB-INF/templates/views/pages/example_done.jsp index 9f1609f7..d976fcff 100644 --- a/src/main/webapp/WEB-INF/templates/views/pages/example_done.jsp +++ b/src/main/webapp/WEB-INF/templates/views/pages/example_done.jsp @@ -7,11 +7,47 @@ -

- 

${done.json}
-

+ + + + + +

+ ${formattedJson} +

+ + +

+ 

${done.json}
+

+ + + + + + + + + + + + + + + + +
+ +
-

Continue

+ + +

${launcherTexts.getContinueButton()}

+ + +

${launcherTexts.getContinueButton()}

+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/example_done_compare.jsp b/src/main/webapp/WEB-INF/templates/views/pages/example_done_compare.jsp index d5b5edd7..238602e2 100644 --- a/src/main/webapp/WEB-INF/templates/views/pages/example_done_compare.jsp +++ b/src/main/webapp/WEB-INF/templates/views/pages/example_done_compare.jsp @@ -23,6 +23,6 @@ -

Continue

+

${launcherTexts.getContinueButton()}

diff --git a/src/main/webapp/WEB-INF/templates/views/pages/example_pending.jsp b/src/main/webapp/WEB-INF/templates/views/pages/example_pending.jsp new file mode 100644 index 00000000..1357b250 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/example_pending.jsp @@ -0,0 +1,8 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + +

${done.name}

+

${done.message}

+ + + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg001.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg001.jsp deleted file mode 100644 index 1a689fbe..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg001.jsp +++ /dev/null @@ -1,40 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

1. Embedded Signing Ceremony

-

This example sends an envelope, and then uses an embedded signing ceremony for the first signer.

-

Embedded signing provides a smoother user experience for the signer: the DocuSign signing ceremony is initiated from - your website.

- -

Documentation about this example.

- - - -

API methods used: - Envelopes::create - and - EnvelopeViews::createRecipient. -

-

- View source file ${sourceFile} on GitHub. -

- -
-
- - - We'll never share your email with anyone else. -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg002.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg002.jsp deleted file mode 100644 index 6958c6f3..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg002.jsp +++ /dev/null @@ -1,53 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

2. Send an envelope with a remote (email) signer and cc recipient

-

The envelope includes a pdf, Word, and HTML document. Anchor text - (AutoPlace) - is used to position the signing fields in the documents. -

-

This is a general example of creating and sending an envelope (a signing request) to multiple recipients, - with multiple documents, and with signature fields for the documents.

- -

Documentation about this example.

- - -

API method used: - Envelopes::create. -

- -

- View source file ${sourceFile} on GitHub. -

- -
-
- - - We'll never share your email with anyone else. -
-
- - -
-
- - - The email and/or name for the cc recipient must be different - from the signer. - -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg003.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg003.jsp deleted file mode 100644 index e8dfd42d..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg003.jsp +++ /dev/null @@ -1,25 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

3. List envelopes in the user's account

-

List the envelopes created in the last 30 days.

-

This example demonstrates how to query DocuSign about envelopes sent by the current user.

- -

Documentation about this example.

- - - -

API method used: - Envelopes::listStatusChanges. -

-

- View source file ${sourceFile} on GitHub. -

- -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg004.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg004.jsp deleted file mode 100644 index 051abe61..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg004.jsp +++ /dev/null @@ -1,48 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

4. Get an envelope's basic information and status

-

List the basic information about an envelope, including its overall status. - Additional API/SDK methods may be used to get additional information about the - envelope, its documents, recipients, etc.

- -

This example demonstrates how to obtain the latest information about - an envelope from DocuSign. Often an alternative is to use Connect - to enable DocuSign to proactively send your application updates when the - status of an envelope changes. -

- - -

Documentation about this example.

- - - -

API method used: - Envelopes::get. -

- -

- View source file ${sourceFile} on GitHub. -

- - - -

The envelope you created via example 2 will be queried.

- -
- - -
- - -

Problem: please first create an envelope using example 2.
- Thank you.

- -
- -
- - - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg005.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg005.jsp deleted file mode 100644 index f0cff895..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg005.jsp +++ /dev/null @@ -1,40 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

5. List an envelope's recipients and their status

-

List the envelope's recipients, including their current status.

- - -

Documentation about this example.

- - - -

API method used: - EnvelopeRecipients::list. -

-

- View source file ${sourceFile} on GitHub. -

- - - -

The envelope you created via example 2 will be queried.

- -
- - -
- - -

Problem: please first create an envelope using example 2.
- Thank you.

- -
- -
- - - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg006.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg006.jsp deleted file mode 100644 index a0341084..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg006.jsp +++ /dev/null @@ -1,43 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

6. List an envelope's documents

-

List the envelope's documents. A Certificate of Completion document - is also associated with every envelope. -

- -

This method is often used to dynamically create a list of an envelope's documents - in preparation for enabling your user to download one or more of the documents.

- -

Documentation about this example.

- - - -

API method used: - EnvelopeDocuments::list. -

- -

- View source file ${sourceFile} on GitHub. -

- - - -

The envelope you created via example 2 will be queried.

- -
- - -
- - -

Problem: please first create an envelope using example 2.
- Thank you.

- -
- -
- - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg007.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg007.jsp deleted file mode 100644 index 89eed27e..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg007.jsp +++ /dev/null @@ -1,71 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

7. Download a document from an envelope

-

An envelope's documents can be downloaded one by one or as a complete set.

-

Document download options:

-
    -
  • Combined: a PDF with the combined content of all documents and the - certificate -
    • -
  • Zip Archive: a ZIP archive that contains all of the PDF documents, - the certificate, and any .WAV files used for voice authentication. -
    • -
  • The envelope's individual documents
    • -
  • The envelope's Certificate of Completion
    • -
- -

Documentation about this example.

- - - -

API method used: - EnvelopeDocuments::get. -

- -

- View source file ${sourceFile} on GitHub. -

- - - -

Problem: please first create an envelope using example 2.
- You will then need to use example 6 to create the list of documents.
- Thank you.

- -
- -
- - -

Problem: please first create a list of the envelope's documents using - example 6.
- Thank you.

- -
- -
- - -

Please choose a document.
- The document list is from your results for example 6.

- -
-
- - -
- - -
- - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg008.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg008.jsp deleted file mode 100644 index fd249303..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg008.jsp +++ /dev/null @@ -1,34 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

8. Create a template

-

Create a template with two roles, signer and cc. - The template includes three documents. -

- -

Templates are usually created using the DocuSign web tool. This example creates - a template that will later be used by other examples in this launcher.

- -

This example first lists the user's templates and only creates a new template if one does not already exist in your - account. -

- -

Documentation about this example.

- - - -

API methods used: - Templates::list, - Templates::create. -

- -

- View source file ${sourceFile} on GitHub. -

- -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg009.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg009.jsp deleted file mode 100644 index 227dfc8b..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg009.jsp +++ /dev/null @@ -1,79 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

9. Send an envelope using a template

-

The envelope is defined by the template. - The signer and cc recipient name and email are used to fill in the template's roles.

- -

This example demonstrates a common pattern for DocuSign integrations: envelopes will - be sent programmatically, based on a template. If the template definition needs to be - updated, the DocuSign web tool can be used to easily update the template, thus - avoiding the need to make software changes. -

- - -

Documentation about this example.

- - - -

API method used: - Envelopes::create. -

-

- View source file ${sourceFile} on GitHub. -

- - - -

The template you created via example 8 will be used.

- -
-
- -
-
- - - We'll never share your email with anyone else. - -
-
- - -
-
- - - The email and/or name for the cc recipient must be - different from the signer. - -
-
- - -
- - -
- - -

Problem: please first create the template using example 8.
- Thank you.

- -
- -
- - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg010.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg010.jsp deleted file mode 100644 index 008fd01c..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg010.jsp +++ /dev/null @@ -1,53 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

10. Send an envelope using binary document transfer

-

The envelope includes a pdf, Word, and HTML document.

-

Multipart data transfer is used to send the documents in binary format to DocuSign. - Binary transfer is 33% more efficient than base64 encoding and is recommended for documents over 15M Bytes. -

- -

Since binary transfer is not yet supported by the SDK, this example uses the API directly and - demonstrates how to do so.

- -

Documentation about this example.

- - - -

API method used: - Envelopes::create. -

- -

- View source file ${sourceFile} on GitHub. -

- -
-
- - - We'll never share your email with anyone else. -
-
- - -
-
- - - The email and/or name for the cc recipient must be different from the signer. -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg011.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg011.jsp deleted file mode 100644 index c67e4034..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg011.jsp +++ /dev/null @@ -1,66 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

11. Embedded Sending

-

An envelope will be created in draft mode. Your browser will then be redirected to - the DocuSign web tool where the envelope can be (optionally) updated and then sent.

-

The envelope includes a pdf, Word, and HTML document. Anchor text - (AutoPlace) - is used to position the signing fields in the documents.

-

DocuSign recommends that you enhance your application as needed to avoid the need - for the embedded sender view. -

-

For example, if the sender view is used to optionally - add additional documents to the envelope, enhance your app to provide the - needed feature (see example 13 for adding additional documents programmatically). -

- -

Documentation about this example.

- - - -

API methods used: - Envelopes::create and - EnvelopeViews::createSender. -

- -

- View source file ${sourceFile} on GitHub. -

- -
-
- - -
-
- - - We'll never share your email with anyone else. -
-
- - -
-
- - - The email and/or name for the cc recipient must be different from the signer. -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg012.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg012.jsp deleted file mode 100644 index 97134c97..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg012.jsp +++ /dev/null @@ -1,47 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

12. Embedded DocuSign web tool

-

Redirect the user to the DocuSign web tool.

-

Use this API call to open the DocuSign web tool, the NDSE (New DocuSign Signing Experience), - with the user already logged in.

-

The starting view can be either an envelope's documents or the web tool's front page.

-

The user does not necessarily return from the NDSE, so using this API call is often a final - step for your application. - Or you can open the NDSE in a new tab for the user. -

- - -

Documentation about this example.

- - - -

API method used: - EnvelopeViews::createConsole. -

- -

- View source file ${sourceFile} on GitHub. -

- -

Optional: to use the Envelope's document view please first create an envelope using - example 2.

- - - -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg013.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg013.jsp deleted file mode 100644 index 3739cb36..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg013.jsp +++ /dev/null @@ -1,116 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

13. Embedded Signing Ceremony from a template with an added document

- -

This example sends an envelope based on a template.

-

In addition to the template's document(s), the example adds an - additional document to the envelope by using the - Composite - Templates - feature.

-

In this example, the additional document is an HTML document that - includes order details with information from the form below.

-

This example then enables you to sign the envelope using embedded signing.

-

Embedded signing provides a smoother user experience for a signer who is - already logged into your web application since the DocuSign - signing ceremony is initiated from your website.

- - - -

Documentation about this example.

- - - -

API methods used: - Envelopes::create - and - EnvelopeViews::createRecipient. -

-

- View source file ${sourceFile} on GitHub. -

- - -

The template you created via example 8 will be used.

- -
-
- -
-
- - - We'll never share your email with anyone else. - -
-
- - -
-
- - - The email and/or name for the cc recipient must be - different - from the signer. - -
-
- - -
-

-

-

-
- - -
-
- - -
- - -
- - -

Problem: please first create the template using example 8.
- Thank you.

- -
- -
- - - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg014.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg014.jsp deleted file mode 100644 index 37e49588..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg014.jsp +++ /dev/null @@ -1,64 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

14. Send an envelope with an order form, including a payment field.

- -
Note: This example will only work if the sender's DocuSign account - is set up with a DocuSign payment gateway. Since the Payment Gateway ID - is set in the configuration file, you will need to run your - own instance of this project to set it. -
- -

Anchor strings - (AutoPlace) - are used to position the fields in the documents. -

- - -

Documentation about this example.

- - -

API method used: - Envelopes::create. -

- -

- View source file ${sourceFile} on GitHub. -

- - - -
-
- - - We'll never share your email with anyone else. -
-
- - -
-
- - - The email for the cc recipient must be different from the signer's email. -
-
- - -
- - -
- - -

Problem: please set the DS_PAYMENT_GATEWAY_ID value in the configuration file.

- - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg015.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg015.jsp deleted file mode 100644 index 7f451ab3..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg015.jsp +++ /dev/null @@ -1,51 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

15. Get the tab data from an envelope.

- -

Get the tab (field) values from an envelope for all of the envelope's recipients.

- -

- This method is used to read the updated tab values from - the envelope. The method can be used after the envelope is complete or while it is - still in progress. -

- - - - -

Documentation about this example.

- - -

- API method used: - EnvelopeFormData::get. -

- -

- View source file ${sourceFile} on GitHub. -

- - - -

- The last envelope you created with this example launcher will be queried. - Recommendation: use example 9, then this example, since example 9 includes many tabs of different types. -

- -
- - -
- - -

Problem: please first create an envelope using example 9.
- Thank you.

- -
- -
- - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg016.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg016.jsp deleted file mode 100644 index aaa47d98..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg016.jsp +++ /dev/null @@ -1,56 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

16. Set tab values for an envelope.

- -

- This example creates an example with both read-only tabs (fields) and tabs that can - be updated by the recipient. -

-

The example also sets custom metadata in the envelope via the envelope custom fields feature.

- - - - -

Documentation about this example.

- - -

- API method used: - EnvelopeFormData::get. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-
- - - We'll never share your email with anyone else. -
-
- - -
-
- - - The email for the cc recipient must be different from the signer's email. -
-
- - -
- - -
- - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg017.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg017.jsp deleted file mode 100644 index 50aeba3f..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg017.jsp +++ /dev/null @@ -1,64 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - - -

17. Set template tab values

-

- This example sets the value of a template's tabs. It includes setting - radio button and checkbox tabs. -

-

The example also sets custom metadata in the envelope via the envelope custom fields feature.

- - -

Documentation about this example.

- - -

API method used: - Envelopes::create. -

-

- View source file ${sourceFile} on GitHub. -

- - - -

The template you created via example 8 will be used.

-
-
- - - We'll never share your email with anyone else. -
-
- - -
-
- - - The email for the cc recipient must be different from the signer's email. -
-
- - -
- - -
- - - -

Problem: please first create the template using example 8.
- Thank you.

- -
- -
- - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg018.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg018.jsp deleted file mode 100644 index 0a90c072..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg018.jsp +++ /dev/null @@ -1,52 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

18. Get the custom field data for an envelope

-

- Get the data values associated with the envelope itself. The custom data fields enable you to - add additional meta-data to the envelope. The custom data fields can be set by the Sender - via the DocuSign web tool, or can be set programmatically. The data can be included in the - envelope's certificate of completion. -

- -

- This method is used to read the custom field values from - an envelope. -

- - -

Documentation about this example.

- - - -

- API method used: - EnvelopeCustomFields::list. -

-

- View source file ${sourceFile} on GitHub. -

- - - -

- The last envelope you created with this example launcher will be queried. - Recommendation: use example 9, then this example, since example 9 includes many tabs of different types. -

-
- - -
- - -

Problem: please first create an envelope using example 9.
- Thank you.

- -
- -
- - - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg019.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg019.jsp deleted file mode 100644 index e0955e80..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg019.jsp +++ /dev/null @@ -1,51 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

19. Send an envelope with a recipient using Access Code Authentication.

- -

- The envelope includes a pdf document. Anchor text - (AutoPlace) - is used to position the signing fields in the documents. -

-

- This is a general example of creating and sending an envelope (a signing request) using An Access Code for Recipient Authentication. -

- - -

Documentation about this example.

- - -

API method used: - Envelopes::create. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-
- - - Provide this string to a recipient that is different such as in person or by mail or via different email. -
-
- - - We'll never share your email with anyone else. -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg020.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg020.jsp deleted file mode 100644 index c0daa432..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg020.jsp +++ /dev/null @@ -1,36 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

20. Send an envelope with a recipient using SMS Authentication.

- - -

Documentation about this example.

- - -

API method used: - Envelopes::create. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-
- - - We'll never share your email with anyone else. -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg021.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg021.jsp deleted file mode 100644 index 85007e4d..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg021.jsp +++ /dev/null @@ -1,36 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

21. Send an envelope with a recipient using Phone Authentication.

- - -

Documentation about this example.

- - -

API method used: - Envelopes::create. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-
- - - We'll never share your email with anyone else. -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg022.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg022.jsp deleted file mode 100644 index 667e08c9..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg022.jsp +++ /dev/null @@ -1,36 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

22. Send an envelope with a recipient using Knowledge-Based Authentication.

- - -

Documentation about this example.

- - -

API method used: - Envelopes::create. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-
- - - We'll never share your email with anyone else. -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg023.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg023.jsp deleted file mode 100644 index cc628383..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg023.jsp +++ /dev/null @@ -1,45 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

23. Requiring Id Verification for a Recipient

- -

- The envelope includes a pdf document. Anchor text - (AutoPlace) - is used to position the signing fields in the documents. -

-

- This is a general example of creating and sending an envelope (a signing request) using ID Verification for Recipient Authentication. -

- - -

Documentation about this example.

- - -

- API method used: - Envelopes::create. -

- -

- View source file ${sourceFile} on GitHub. -

- -
-
- - - We'll never share your email with anyone else. -
-
- - -
- - -
- - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg024.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg024.jsp deleted file mode 100644 index dbd066d9..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg024.jsp +++ /dev/null @@ -1,34 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

24. ${title}.

- -

-Permission profiles are collections of account settings that determine the behavior and actions -available to the user groups to which they're applied. This code example demonstrates how to -create a permission profile with the eSignature REST API. -

- - -

Documentation about this example.

- - -

API method used: - AccountPermissionProfiles::create. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-
- - -
- - -
- - \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg026.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg026.jsp deleted file mode 100644 index e71c0566..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg026.jsp +++ /dev/null @@ -1,66 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

26. ${title}.

- -

-This code example demonstrates how to edit individual permission settings on a permissions profile -with the eSignature REST API. -

- - -

Documentation about this example.

- - -

API method used: - AccountPermissionProfiles::update. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-
- - -
- -<%--
--%> -<%-- --%> -<%-- --%> -<%--
--%> -<%-- --%> -<%--

There is no account role settings is defined

--%> -<%-- --%> -<%-- --%> -<%-- --%> -<%-- --%> -<%-- --%> -<%-- --%> -<%-- --%> -<%-- --%> -<%-- --%> -<%--
${property.name}${property.leftValue}
--%> - - -
- - - - \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg027.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg027.jsp deleted file mode 100644 index c427e350..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg027.jsp +++ /dev/null @@ -1,39 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

27. ${title}.

- -

- Permission profiles are collections of account settings that determine the behavior and actions - available to the user groups to which they're applied. This code example demonstrates how to - delete a permission profile with the eSignature REST API. -

- - -

Documentation about this example.

- - -

API method used: - AccountPermissionProfiles::update. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-
- - -
- - - -
- - \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg028.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg028.jsp deleted file mode 100644 index 131aed33..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg028.jsp +++ /dev/null @@ -1,50 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

28. Creating a brand.

- -

- The brand includes a Brand Name Configure Brands. -

-

- DocuSign enables you to customize the eSignature sending and signing experience with your own - branding elements-logo, colors, and more-stored as a collection of settings called a brand in - your DocuSign account. This code example demonstrates how to create a brand with the - eSignature REST API that you subsequently apply to a DocuSign envelope. -

- - -

Documentation about this example.

- - -

API method used: - AccountBrands::create. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-

- New brand -

-
- - -
-
- - -
- - -
- - \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg029.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg029.jsp deleted file mode 100644 index 00924592..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg029.jsp +++ /dev/null @@ -1,74 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%> - - -

29. Applying a brand to an envelope

-

- The envelope includes a pdf document. Anchor text (AutoPlace) - is used to position the signing fields in the documents. -

-

- DocuSign enables you to customize the eSignature sending and signing experience with your own - branding elements-logo, colors, and more-stored as a collection of settings called a brand in - your DocuSign account. This code example demonstrates how to create a brand with the eSignature - REST API that you subsequently apply to a DocuSign envelope. -

- -

- Documentation about - this example. -

- - - -

- API method used: Envelopes::create. -

-

- View source file ${sourceFile} - on GitHub. -

- - - -
-
- We'll never - share your email with anyone else. -
-
- -
-
- - - - There are no brands - created in your account. Create ones at the 'Create brand' page. - - -
- - -
- - -

Problem: please first create the brand(s) using example 24.
Thank you.

-
- -
- - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg030.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg030.jsp deleted file mode 100644 index 8f816b41..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg030.jsp +++ /dev/null @@ -1,102 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%> - - -

30. Applying a brand to a template

-

This code example demonstrates how to apply a brand to an template.

-

- The envelope is defined by the template. The signer and cc recipient - name and email are used to fill in the template's roles. -

- -

- This example demonstrates a common pattern for DocuSign integrations: envelopes will be sent - programmatically, based on a template. If the template definition needs to be updated, the - DocuSign web tool can be used to easily update the template, thus avoiding the need to make - software changes. -

- -

- Documentation about this example. -

- - - -

- API method used: Envelopes::create. -

-

- View source file ${sourceFile} on GitHub. -

- - - -

The template you created via example 8 and brands created via - example 24 will be used.

-
-
- We'll never - share your email with anyone else. -
-
- -
-
- - The email - and/or name for the cc recipient must be different from the signer. -
-
- -
-
- -
-
- - -
- - -
- - - -

Problem: please create the template using example 8.

- - -

Problem: please create the brand using example 24.

- - -
- -
- - -
- -
- - - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg031.jsp b/src/main/webapp/WEB-INF/templates/views/pages/examples/eg031.jsp deleted file mode 100644 index 654ef489..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/examples/eg031.jsp +++ /dev/null @@ -1,87 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - -

31. ${title}.

- -

- This code example demonstrates how to send envelopes in bulk to multiple recipients with the - eSignature API. To accomplish the task, you will first create a bulk send recipients list, - and then create an envelope. From there, you will combine the envelope and bulk list to - initiate bulk send. Method BulkSend::createBulkSendList creates a bulk send list that you can - use to send an envelope to up to 1,000 recipients at once. -

- - -

Documentation about this example.

- - -

API methods used: - EnvelopeRecipients::create, - Envelopes::create, - BulkEnvelopes::get, - EnvelopeCustomFields::create, - BulkSend::createBulkSendList - EnvelopeRecipients::create. -

- -

- View source file ${sourceFile} on GitHub. -

- - -
-
- - - We'll never share your email with anyone else. -
-
- - -
-
- - - The email and/or name for the cc recipient must be different - from the signer. - -
-
- - -
- -
- - - We'll never share your email with anyone else. -
-
- - -
-
- - - The email and/or name for the cc recipient must be different - from the signer. - -
-
- - -
- - - -
- - \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/index.jsp b/src/main/webapp/WEB-INF/templates/views/pages/index.jsp deleted file mode 100644 index a99c03c3..00000000 --- a/src/main/webapp/WEB-INF/templates/views/pages/index.jsp +++ /dev/null @@ -1,252 +0,0 @@ -<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> - - - - -
-

Welcome!

-

Welcome to the DocuSign Java Example Launcher - using OAuth2.

-
- - -
-

Welcome

-

This launcher both demonstrates use of common OAuth2 grant flows and multiple usage examples from the DocuSign eSignature REST API.

- -

Documentation on using OAuth Authorization Code Grant from a Java application.

- - -

Basic Examples

- -

1. Embedded Signing Ceremony

-

This example sends an envelope, and then uses an embedded signing ceremony for the first signer. - With embedded signing, the DocuSign signing ceremony is initiated from your website. -

-

API methods used: - Envelopes::create and - EnvelopeViews::createRecipient. -

- -

2. Send an envelope with a remote (email) signer and cc recipient

-

The envelope includes a pdf, Word, and HTML document. Anchor text - (AutoPlace) - is used to position the signing fields in the documents. -

-

API method used: - Envelopes::create. -

- -

3. List envelopes in the user's account

-

List the envelopes created in the last 30 days. -

-

API method used: - Envelopes::listStatusChanges. -

- -

4. Get an envelope's basic information and status

-

List the basic information about an envelope, including its overall status. - Additional API/SDK methods may be used to get additional information about the - envelope, its documents, recipients, etc. -

-

API method used: - Envelopes::get. -

- -

5. List an envelope's recipients and their status

-

List the envelope's recipients, including their current status. -

-

API method used: - EnvelopeRecipients::list. -

- -

6. List an envelope's documents

-

List the envelope's documents. A Certificate of Completion document - is also associated with every envelope. -

-

API method used: - EnvelopeDocuments::list. -

- -

7. Download a document from an envelope

-

An envelope's documents can be downloaded one by one or as a complete set. -

-

API method used: - EnvelopeDocuments::get. -

- -

8. Create a template

-

Create a template with two roles, signer and cc.

-

API methods used: - Templates::list, - Templates::create. -

- -

9. Send an envelope using a template

-

The envelope is defined by the template. - The signer and cc recipient name and email are used to fill in the template's roles.

-

API method used: - Envelopes::create. -

- -

10. Send an envelope using binary document transfer

-

The envelope includes a pdf, Word, and HTML document.

-

Multipart data transfer is used to send the documents in binary format to DocuSign. - Binary transfer is 33% more efficient than base64 encoding and is recommended for documents over 15M Bytes. - Binary transfer is not yet supported by the SDK. -

-

API method used: - Envelopes::create. -

- -

11. Embedded sending

-

An envelope will be created in draft mode. The DocuSign - web tool (NDSE) will then be shown, enabling further updates - to the envelope before it is sent. -

-

API methods used: - Envelopes::create, - EnvelopeViews::createSender. - -

12. Embedded DocuSign web tool

-

Redirect the user to the DocuSign web tool.

-

API method used: - EnvelopeViews::createConsole. -

- -

13. Embedded Signing Ceremony from a template with an added document

-

This example sends an envelope based on a template.

-

In addition to the template's document(s), the example adds an - additional document to the envelope by using the - Composite Templates - feature.

-

API methods used: - Envelopes::create and - EnvelopeViews::createRecipient. -

- -

14. Send an envelope with an order form and payment field

-

Anchor text - (AutoPlace) - is used to position the fields in the documents. -

-

API method used: - Envelopes::create. -

- - - -

Tabs Examples

-

15. Get the tab data from an envelope

-

This example retrieves the tab (field) values from an envelope.

-

- API method used: - EnvelopeFormData::get. -

- -

16. Set tab values for an envelope

-

This example sets the tab (field) values for an envelope including tabs that can and cannot be changed by the signer.

-

- API method used: - Envelopes::create and - EnvelopeViews::createRecipient. -

- -

17. Set template tab values

-

This example sets the tab (field) values for a template being used by an envelope.

-

- API method used: - Envelopes::create and - EnvelopeViews::createRecipient. -

- -

18. List envelope custom metadata field values

-

This example lists the envelope's custom metadata field values.

-

- API method used: - EnvelopeCustomFields::list. -

- - -

19. Send an envelope with Access Code Authentication

-

This example sends and envelope that requires an access-code for the purpose of multi-factor authentication.

-

API method used: - Envelopes::create. -

- -

20. Send an envelope with SMS Authentication

-

This example sends and envelope that requires entering in a six digit code from an text message for the purpose of multi-factor authentication.

-

API method used: - Envelopes::create. -

- -

21. Send an envelope with Phone Authentication

-

This example sends and envelope that requires entering in a voice-based response code for the purpose of multi-factor authentication.

-

API method used: - Envelopes::create. -

- -

22. Send an envelope with Knowledge-Based Authentication

-

This example sends and envelope that requires passing a Public records check to validate identity for the purpose of multi-factor authentication.

-

API method used: - Envelopes::create. -

- -

23. Send an envelope with ID Verification Authentication

-

Submit an envelope that requires verification of a government issued identity.

-

- API method used: - Envelopes::create. -

- -

24. Creating a Permission Profile

-

- Coming Soon -

- -

25. Setting a permission profile

-

This example allows you to set a permission profile on an existing user group.

-

API method used: - Groups::update. -

- -

26. Modify a Permission Profile

-

- Coming Soon -

- -

27. Deleting a permission profile

-

This example lists all available permissions profiles and allows you to delete any without associated users. Please note that you cannot remove "Everyone" nor "Administrator" permission profiles.

-

API method used: - AccountPermissionProfiles::create. -

- -

28. Create a brand

-

This example will create an account brand that can be used to apply customization to your envelopes such as your own logo, colors, and text elements.

-

API method used: - AccountBrands::create. -

- -

29. Applying a brand to an envelope

-

This example will show you how to create an envelope using any of the created brands on your account.

-

API method used: - Envelopes::create. -

- -

30. Applying a brand to a template

-

This example will show you how to create an envelope using a brand

-

API method used: - Envelopes::create. -

- -

31. Bulk sending envelopes to multiple recipients

-

- Coming Soon -

-
- - - - - - diff --git a/src/main/webapp/WEB-INF/templates/views/pages/links_to_api_methods.jsp b/src/main/webapp/WEB-INF/templates/views/pages/links_to_api_methods.jsp new file mode 100644 index 00000000..158ef8ff --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/links_to_api_methods.jsp @@ -0,0 +1,30 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + +

+ + + + ${launcherTexts.getAPIMethodUsed()} + + + ${launcherTexts.getAPIMethodUsedPlural()} + + + + + ${link.getPathName()} + + + + . + + + and + + + , + + + + +

diff --git a/src/main/webapp/WEB-INF/templates/views/pages/monitor/examples/m001.jsp b/src/main/webapp/WEB-INF/templates/views/pages/monitor/examples/m001.jsp new file mode 100644 index 00000000..3c554970 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/monitor/examples/m001.jsp @@ -0,0 +1,21 @@ +<%@ taglib prefix='c' uri='http://java.sun.com/jsp/jstl/core' %> + + +

1. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

Documentation about this example.

+ + + + +

+ ${viewSourceFile} +

+ +
+ + +
+ + diff --git a/src/main/webapp/WEB-INF/templates/views/pages/monitor/examples/m002.jsp b/src/main/webapp/WEB-INF/templates/views/pages/monitor/examples/m002.jsp new file mode 100644 index 00000000..990a6fd9 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/monitor/examples/m002.jsp @@ -0,0 +1,49 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

2. ${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

+ ${viewSourceFile} +

+ +

+ ${example.getForms().get(formNumber).getFormName()} +

+ +
+ +
+ + + +
+
+ + + +
+ + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r001.jsp b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r001.jsp new file mode 100644 index 00000000..7c855526 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r001.jsp @@ -0,0 +1,32 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+ +

+ ${viewSourceFile} +

+ + +
+
+ + + +
+ + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r002.jsp b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r002.jsp new file mode 100644 index 00000000..06f60a40 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r002.jsp @@ -0,0 +1,52 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

+ ${viewSourceFile} +

+ + + + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText()} +

+ + +
+
+ + + +
+
+ + + +
+ + +
+ + + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r003.jsp b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r003.jsp new file mode 100644 index 00000000..e043d89c --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r003.jsp @@ -0,0 +1,41 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

+ ${viewSourceFile} +

+ + + + +

+ ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToFirstCodeExample)} +

+ + +
+
+ + + +
+ + +
+ + + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r004.jsp b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r004.jsp new file mode 100644 index 00000000..0d74b7b7 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r004.jsp @@ -0,0 +1,65 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

+ ${viewSourceFile} +

+ + + +
+ + +
+ + + +
+ + + ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToFirstCodeExample)} + + + + +
+ + + + + + + +

Problem: this room have already all the form

+ + +
+ + + + +
+ + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r005.jsp b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r005.jsp new file mode 100644 index 00000000..0217f06c --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r005.jsp @@ -0,0 +1,46 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

+ ${viewSourceFile} +

+ + +
+ +
+ + + +
+
+ + + +
+ + + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r006.jsp b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r006.jsp new file mode 100644 index 00000000..64086a46 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r006.jsp @@ -0,0 +1,81 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

+ ${viewSourceFile} +

+ + + + + ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToFirstCodeExample)} + +
+ +
+ + + +
+
+
+

${example.getForms().get(formNumber).getFormName()}

+ + + +
+ + +
+
+
+ + + + ${example.getRedirectsToOtherCodeExamples().get(redirectNoDocumentsNumber).getRedirectText().replaceFirst("\\{0}", redirectToForthCodeExample)} +
+ +
+ + + +
+
+
+

${example.getForms().get(formDocumentsNumber).getFormName()}

+ + + +
+ + + +
+
+ + + + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r007.jsp b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r007.jsp new file mode 100644 index 00000000..5ba4a75f --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r007.jsp @@ -0,0 +1,31 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

+ ${viewSourceFile} +

+ + +
+
+ + + +
+ + +
+ + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r008.jsp b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r008.jsp new file mode 100644 index 00000000..dd253d60 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r008.jsp @@ -0,0 +1,54 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

+ ${viewSourceFile} +

+ + + +
+ + + ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToSeventhCodeExample)} + + +

Problem: cannot find any offices

+ + +
+ + +
+
+ + +
+ + + + +
+ + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r009.jsp b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r009.jsp new file mode 100644 index 00000000..00794187 --- /dev/null +++ b/src/main/webapp/WEB-INF/templates/views/pages/rooms/examples/r009.jsp @@ -0,0 +1,56 @@ +<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> + + + + + + + + +

${example.getExampleName()}

+

${example.getExampleDescription()}

+

+ ${viewSourceFile} +

+ + + +
+ + + ${example.getRedirectsToOtherCodeExamples().get(redirectNumber).getRedirectText().replaceFirst("\\{0}", redirectToSeventhCodeExample)} + + +

Problem: cannot find any forms, please first create a form

+ + +
+ + + +
+
+ + + +
+ + + + +
+ + + \ No newline at end of file diff --git a/src/main/webapp/WEB-INF/templates/views/partials/foot.jsp b/src/main/webapp/WEB-INF/templates/views/partials/foot.jsp index bbe98422..2ed8a460 100644 --- a/src/main/webapp/WEB-INF/templates/views/partials/foot.jsp +++ b/src/main/webapp/WEB-INF/templates/views/partials/foot.jsp @@ -18,10 +18,19 @@ integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"> - + + + + + + diff --git a/src/main/webapp/WEB-INF/templates/views/partials/head.jsp b/src/main/webapp/WEB-INF/templates/views/partials/head.jsp index 349c038b..829489e0 100644 --- a/src/main/webapp/WEB-INF/templates/views/partials/head.jsp +++ b/src/main/webapp/WEB-INF/templates/views/partials/head.jsp @@ -7,7 +7,7 @@ - + ${title} @@ -20,7 +20,7 @@ - -
- - -

- DocuSign Account: ${locals.session.accountName}. -

- - - @@ -77,6 +69,15 @@
- + -
+ + +
+
+ + +
+
+ + \ No newline at end of file diff --git a/src/test/java/tests/Click/ActivateClickwrapTest.java b/src/test/java/tests/Click/ActivateClickwrapTest.java new file mode 100644 index 00000000..473c58d1 --- /dev/null +++ b/src/test/java/tests/Click/ActivateClickwrapTest.java @@ -0,0 +1,56 @@ +package tests.Click; + +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiClient; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapVersionSummaryResponse; +import com.docusign.controller.click.services.ActivateClickwrapService; +import com.docusign.core.model.ApiType; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; + +public final class ActivateClickwrapTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String basePathAddition = "/clickapi"; + + private final ApiClient apiClient; + + private final AccountsApi accountsApi; + + private final TestConfig testConfig; + + public ActivateClickwrapTest() throws IOException, ApiException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.CLICK); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + this.accountsApi = new AccountsApi(apiClient); + CreateClickwrapTest createClickwrapTest = new CreateClickwrapTest(); + createClickwrapTest.CreateClickwrap_CorrectInputValues_ReturnsClickwrapVersionSummaryResponse(); + } + + @Test + public void ActivateClickwrap_CorrectInputValues_ReturnsClickwrapVersionSummaryResponse() throws ApiException { + // Arrange + var statusActive = "active"; + + // Act + ClickwrapVersionSummaryResponse clickwrapVersionSummaryResponse = ActivateClickwrapService.activateClickwrap( + this.accountsApi, + testConfig.getAccountId(), + testConfig.getInactiveClickwrap().getClickwrapId(), + testConfig.getInactiveClickwrap().getVersionNumber() + ); + + // Assert + Assert.assertNotNull(clickwrapVersionSummaryResponse); + Assert.assertEquals(statusActive, clickwrapVersionSummaryResponse.getStatus()); + } +} diff --git a/src/test/java/tests/Click/CreateClickwrapTest.java b/src/test/java/tests/Click/CreateClickwrapTest.java new file mode 100644 index 00000000..af41e678 --- /dev/null +++ b/src/test/java/tests/Click/CreateClickwrapTest.java @@ -0,0 +1,112 @@ +package tests.Click; + +import com.docusign.click.api.AccountsApi; +import com.docusign.click.client.ApiClient; +import com.docusign.click.client.ApiException; +import com.docusign.click.model.ClickwrapRequest; +import com.docusign.click.model.ClickwrapVersionSummaryResponse; +import com.docusign.click.model.DisplaySettings; +import com.docusign.click.model.Document; +import com.docusign.controller.click.examples.ClickwrapHelper; +import com.docusign.controller.click.services.CreateClickwrapService; +import com.docusign.core.model.ApiType; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.util.Random; + +public final class CreateClickwrapTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String DOCUMENT_FILE_NAME = "TermsOfService.pdf"; + + private static final Integer DOCUMENT_ORDER = 0; + + private static final String DOCUMENT_NAME = "Terms of Service"; + + private static final String basePathAddition = "/clickapi"; + + private final ApiClient apiClient; + + private final AccountsApi accountsApi; + + private final TestConfig testConfig; + + public CreateClickwrapTest() throws IOException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.CLICK); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + this.accountsApi = new AccountsApi(apiClient); + } + + @Test + public void CreateClickwrapRequest_CorrectInputValues_ReturnsClickwrapRequest() throws IOException { + // Arrange + String clickwrapName = "Clickwrap name"; + String displayName = "Terms of Service"; + String consentButtonText = "I Agree"; + String format = "modal"; + String documentDisplay = "document"; + + Document document = ClickwrapHelper.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, DOCUMENT_ORDER); + DisplaySettings displaySettings = new DisplaySettings() + .displayName(displayName) + .consentButtonText(consentButtonText) + .downloadable(true) + .format(format) + .mustRead(true) + .requireAccept(true) + .documentDisplay(documentDisplay); + + ClickwrapRequest expectedClickwrapRequest = new ClickwrapRequest() + .addDocumentsItem(document) + .clickwrapName(clickwrapName) + .requireReacceptance(true) + .displaySettings(displaySettings); + + // Act + ClickwrapRequest clickwrapRequest = CreateClickwrapService.createClickwrapRequest( + clickwrapName, + DOCUMENT_FILE_NAME, + DOCUMENT_NAME, + DOCUMENT_ORDER); + + // Assert + Assert.assertNotNull(clickwrapRequest); + Assert.assertEquals(expectedClickwrapRequest, clickwrapRequest); + } + + @Test + public void CreateClickwrap_CorrectInputValues_ReturnsClickwrapVersionSummaryResponse() throws ApiException, IOException { + // Arrange + byte[] byteArray = new byte[8]; + new Random().nextBytes(byteArray); + String clickwrapName = new String(byteArray, StandardCharsets.UTF_8); + + ClickwrapRequest clickwrapRequest = CreateClickwrapService.createClickwrapRequest( + clickwrapName, + DOCUMENT_FILE_NAME, + DOCUMENT_NAME, + DOCUMENT_ORDER); + + // Act + ClickwrapVersionSummaryResponse clickwrapVersionSummaryResponse = CreateClickwrapService.createClickwrap( + this.accountsApi, + testConfig.getAccountId(), + clickwrapRequest); + + testConfig.setInactiveClickwrap(clickwrapVersionSummaryResponse); + + // Assert + Assert.assertNotNull(clickwrapVersionSummaryResponse); + Assert.assertEquals(clickwrapName, clickwrapVersionSummaryResponse.getClickwrapName()); + } +} diff --git a/src/test/java/tests/common/JWTLoginMethodTest.java b/src/test/java/tests/common/JWTLoginMethodTest.java new file mode 100644 index 00000000..92dcdde6 --- /dev/null +++ b/src/test/java/tests/common/JWTLoginMethodTest.java @@ -0,0 +1,73 @@ +package tests.common; + +import com.docusign.core.model.ApiType; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.client.auth.OAuth; +import org.junit.Assert; + +import java.awt.*; +import java.io.IOException; +import java.net.URI; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.Arrays; +import java.util.List; + +public final class JWTLoginMethodTest { + + private static final String RedirectUrl = "https://developers.docusign.com/platform/auth/consent"; + + private static final String CONSENT_REQUIRED_MESSAGE = "Consent required, please provide consent in browser window and then run this app again."; + + private static final String CONSENT_REQUIRED_KEYWORD = "consent_required"; + + public static void RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType apiType) throws IOException { + TestConfig testConfig = TestConfig.getInstance(); + + try { + ApiClient apiClient = new ApiClient(testConfig.getHost()); + List scopes = Arrays.asList(apiType.getScopes()); + + byte[] privateKeyBytes = Files.exists(Path.of(testConfig.getPrivateKeyPath())) ? + Files.readAllBytes(Paths.get(testConfig.getPrivateKeyPath())) + : testConfig.getPrivateKey().getBytes(); + + OAuth.OAuthToken oAuthToken = apiClient.requestJWTUserToken( + testConfig.getClientId(), + testConfig.getImpersonatedUserId(), + scopes, + privateKeyBytes, + 3600); + String accessToken = oAuthToken.getAccessToken(); + OAuth.UserInfo userInfo = apiClient.getUserInfo(accessToken); + String accountId = userInfo.getAccounts().get(0).getAccountId(); + + Assert.assertNotNull(accessToken); + Assert.assertNotNull(accountId); + testConfig.setAccessToken(accessToken); + testConfig.setAccountId(accountId); + } catch (ApiException exp) { + if (exp.getMessage().contains(CONSENT_REQUIRED_KEYWORD)) { + try { + String scopes = "impersonation%20"; + for (String scope : apiType.getScopes()) { + scopes += scope + "%20"; + } + System.out.println(CONSENT_REQUIRED_MESSAGE); + Desktop.getDesktop().browse(new URI( + "https://account-d.docusign.com/oauth/auth?response_type=code&scope=" + + scopes + + "&client_id=" + + testConfig.getClientId() + + "&redirect_uri=" + + JWTLoginMethodTest.RedirectUrl)); + } catch (Exception e) { + System.out.print("Error!!! "); + System.out.print(e.getMessage()); + } + } + } + } +} diff --git a/src/test/java/tests/common/TestConfig.java b/src/test/java/tests/common/TestConfig.java new file mode 100644 index 00000000..562722ed --- /dev/null +++ b/src/test/java/tests/common/TestConfig.java @@ -0,0 +1,112 @@ +package tests.common; + +import com.docusign.click.model.ClickwrapVersionSummaryResponse; +import com.docusign.esign.model.Brand; +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonObject; +import lombok.Getter; +import lombok.Setter; +import org.json.JSONException; +import org.json.JSONObject; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +@Getter +@Setter +public class TestConfig { + private static TestConfig single_instance = null; + + public String PathToDocuments; + + private String ClientId; + + private String Host; + + private String AccountId; + + private String SignerEmail; + + private String SignerName; + + private String ImpersonatedUserId; + + private String OAuthBasePath; + + private String PrivateKeyPath; + + private String PrivateKey; + + private String AccessToken; + + private String BasePath; + + private String BatchId; + + private String TemplateId; + + private ClickwrapVersionSummaryResponse inactiveClickwrap; + + private Brand brand; + + public TestConfig() throws IOException { + PathToDocuments = System.getProperty("user.dir") + "//src//main//resources//"; + Host = "https://demo.docusign.net"; + OAuthBasePath = "account-d.docusign.com"; + PrivateKeyPath = PathToDocuments + "private.key"; + BasePath = "https://demo.docusign.net"; + + try { + var isFilePresentInTheRepository = Files.exists(Path.of(PathToDocuments + "application.json")); + + if (isFilePresentInTheRepository) { + String source = new String(Files.readAllBytes(Paths.get(PathToDocuments + "application.json"))); + + Gson gson = new GsonBuilder().setPrettyPrinting().create(); + + JsonObject originalJsonValue = gson.fromJson(source, JsonObject.class); + JsonObject jwtConfigurationValues = originalJsonValue + .getAsJsonObject("spring") + .getAsJsonObject("security") + .getAsJsonObject("oauth2") + .getAsJsonObject("client") + .getAsJsonObject("registration") + .getAsJsonObject("jwt") + .getAsJsonObject(); + + Object impersonatedUserId = jwtConfigurationValues.get("impersonated-user-guid").toString(); + Object clientId = jwtConfigurationValues.get("client-id").toString(); + Object signerEmail = new JSONObject(source).get("DS_SIGNER_EMAIL"); + Object signerName = new JSONObject(source).get("DS_SIGNER_NAME"); + + if (impersonatedUserId == null || clientId == null || signerEmail == null || signerName == null) { + throw new JSONException("The wrong format of the application.json file."); + } + + ImpersonatedUserId = impersonatedUserId.toString().replace("\"", ""); + ClientId = clientId.toString().replace("\"", ""); + SignerEmail = signerEmail.toString(); + SignerName = signerName.toString(); + } else { + ImpersonatedUserId = System.getenv("IMPERSONATED_USER_ID"); + ClientId = System.getenv("CLIENT_ID"); + SignerEmail = System.getenv("SIGNER_EMAIL"); + SignerName = System.getenv("SIGNER_NAME"); + PrivateKey = System.getenv("PRIVATE_KEY"); + } + } catch (JSONException e) { + e.printStackTrace(); + } + } + + public static TestConfig getInstance() throws IOException { + if (single_instance == null) { + single_instance = new TestConfig(); + } + + return single_instance; + } +} diff --git a/src/test/java/tests/eSignature/AddDocToTemplateTest.java b/src/test/java/tests/eSignature/AddDocToTemplateTest.java new file mode 100644 index 00000000..9866c0fa --- /dev/null +++ b/src/test/java/tests/eSignature/AddDocToTemplateTest.java @@ -0,0 +1,228 @@ +package tests.eSignature; + +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.controller.eSignature.services.AddDocToTemplateService; +import com.docusign.core.common.DocumentType; +import com.docusign.core.model.ApiType; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.Arrays; +import java.util.Collections; + +public final class AddDocToTemplateTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String HTML_DOCUMENT_FILE_NAME = "templates/candy-bonbon2.ftl"; + + private static final String HTML_DOCUMENT_NAME = "Appendix 1--Sales order"; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + + private static final String basePathAddition = "/restapi"; + + private final String SIGNER_CLIENT_ID = "1000"; + + private final String RedirectUrl = "https://developers.docusign.com/platform/auth/consent"; + + private final ApiClient apiClient; + + private final EnvelopesApi envelopesApi; + + private final TestConfig testConfig; + + public AddDocToTemplateTest() throws IOException, ApiException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + this.envelopesApi = new EnvelopesApi(apiClient); + + CreateNewTemplateTest createNewTemplateTest = new CreateNewTemplateTest(); + createNewTemplateTest.CreateTemplate_CorrectInputValues_TemplateSummary(); + } + + @Test + public void AddDocumentToTemplate_CorrectInputValues_ViewUrl() throws ApiException, IOException { + // Arrange + String ccEmail = "cc@gmail.com"; + String ccName = "cc"; + String item = "kiwi"; + String quantity = "1"; + + WorkArguments args = new WorkArguments(); + args.setSignerEmail(testConfig.getSignerEmail()); + args.setSignerName(testConfig.getSignerName()); + args.setCcEmail(ccEmail); + args.setCcName(ccName); + args.setItem(item); + args.setQuantity(quantity); + + // Act + ViewUrl embeddedEnvelope = AddDocToTemplateService.addDocumentToTemplate( + envelopesApi, + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID, + ccEmail, + ccName, + testConfig.getTemplateId(), + testConfig.getAccountId(), + RedirectUrl, + RedirectUrl, + args + ); + + // Assert + Assert.assertNotNull(embeddedEnvelope); + } + + @Test + public void MakeRecipientViewRequest_CorrectInputValues_RecipientViewRequest() { + // Arrange + String pingFrequency = "600"; + String authenticationMethod = "none"; + + RecipientViewRequest expectedViewRequest = new RecipientViewRequest(); + expectedViewRequest.setReturnUrl(RedirectUrl); + expectedViewRequest.setAuthenticationMethod(authenticationMethod); + expectedViewRequest.setEmail(testConfig.getSignerEmail()); + expectedViewRequest.setUserName(testConfig.getSignerName()); + expectedViewRequest.setClientUserId(SIGNER_CLIENT_ID); + expectedViewRequest.setPingFrequency(pingFrequency); + expectedViewRequest.setPingUrl(RedirectUrl); + + // Act + RecipientViewRequest recipientViewRequest = AddDocToTemplateService.makeRecipientViewRequest( + RedirectUrl, + testConfig.getSignerEmail(), + testConfig.getSignerName(), + RedirectUrl + ); + + // Assert + Assert.assertNotNull(recipientViewRequest); + Assert.assertEquals(expectedViewRequest, recipientViewRequest); + } + + @Test + public void MakeEnvelope_CorrectInputValues_EnvelopeDefinition() throws IOException { + // Arrange + String ccEmail = "cc@gmail.com"; + String ccName = "cc"; + String item = "kiwi"; + String defaultIdOne = "1"; + String defaultIdTwo = "2"; + String anchorString = "**signature_1**"; + + WorkArguments args = new WorkArguments(); + args.setSignerEmail(testConfig.getSignerEmail()); + args.setSignerName(testConfig.getSignerName()); + args.setCcEmail(ccEmail); + args.setCcName(ccName); + args.setItem(item); + args.setQuantity(defaultIdOne); + + CarbonCopy cc = new CarbonCopy(); + cc.setEmail(ccEmail); + cc.setName(ccName); + cc.setRoleName(EnvelopeHelpers.CC_ROLE_NAME); + cc.setRecipientId(defaultIdTwo); + + CompositeTemplate compositeTemplate = new CompositeTemplate(); + compositeTemplate.setCompositeTemplateId(defaultIdOne); + ServerTemplate serverTemplates = new ServerTemplate(); + serverTemplates.setSequence(defaultIdOne); + serverTemplates.setTemplateId(testConfig.getTemplateId()); + compositeTemplate.setServerTemplates(Collections.singletonList(serverTemplates)); + + InlineTemplate inlineTemplate = new InlineTemplate(); + inlineTemplate.setSequence(defaultIdTwo); + inlineTemplate.setRecipients(EnvelopeHelpers.createRecipients( + AddDocToTemplateService.createSigner( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID + ), + cc)); + compositeTemplate.setInlineTemplates(Collections.singletonList(inlineTemplate)); + + Tabs signer1Tabs = EnvelopeHelpers.createSingleSignerTab( + anchorString, + ANCHOR_OFFSET_Y, + ANCHOR_OFFSET_X); + Signer signer1AddedDoc = AddDocToTemplateService.createSigner( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID + ); + signer1AddedDoc.setTabs(signer1Tabs); + + byte[] htmlDoc = EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args) + .getBytes(StandardCharsets.UTF_8); + + CompositeTemplate compTemplate2 = new CompositeTemplate(); + compTemplate2.setCompositeTemplateId(defaultIdTwo); + InlineTemplate inlineTemplate2 = new InlineTemplate(); + inlineTemplate2.setSequence(defaultIdOne); + inlineTemplate2.setRecipients(EnvelopeHelpers.createRecipients(signer1AddedDoc, cc)); + compTemplate2.setInlineTemplates(Collections.singletonList(inlineTemplate2)); + compTemplate2.setDocument(EnvelopeHelpers.createDocument(htmlDoc, HTML_DOCUMENT_NAME, + DocumentType.HTML.getDefaultFileExtention(), defaultIdOne)); + + EnvelopeDefinition expectedEnvelopeDefinition = new EnvelopeDefinition(); + expectedEnvelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + expectedEnvelopeDefinition.setCompositeTemplates(Arrays.asList(compositeTemplate, compTemplate2)); + + // Act + EnvelopeDefinition envelopeDefinition = AddDocToTemplateService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID, + ccEmail, + ccName, + testConfig.getTemplateId(), + args + ); + + // Assert + Assert.assertNotNull(envelopeDefinition); + Assert.assertEquals(expectedEnvelopeDefinition, envelopeDefinition); + } + + @Test + public void CreateSigner_CorrectInputValues_Signer() { + // Arrange + String recipientId = "1"; + Signer expectedSigner = new Signer(); + expectedSigner.setEmail(testConfig.getSignerEmail()); + expectedSigner.setName(testConfig.getSignerName()); + expectedSigner.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + expectedSigner.setRecipientId(recipientId); + expectedSigner.setClientUserId(SIGNER_CLIENT_ID); + + // Act + Signer signer = AddDocToTemplateService.createSigner( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID + ); + + // Assert + Assert.assertNotNull(signer); + Assert.assertEquals(expectedSigner, signer); + } +} diff --git a/src/test/java/tests/eSignature/ApplyBrandToEnvelopeTest.java b/src/test/java/tests/eSignature/ApplyBrandToEnvelopeTest.java new file mode 100644 index 00000000..bc26ba64 --- /dev/null +++ b/src/test/java/tests/eSignature/ApplyBrandToEnvelopeTest.java @@ -0,0 +1,120 @@ +package tests.eSignature; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.controller.eSignature.services.ApplyBrandToEnvelopeService; +import com.docusign.core.model.ApiType; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.util.Collections; +import java.util.List; + +public final class ApplyBrandToEnvelopeTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "EG025 Lorem Ipsum"; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + + private static final String basePathAddition = "/restapi"; + + private final ApiClient apiClient; + + private final AccountsApi accountsApi; + + private final EnvelopesApi envelopesApi; + + private final TestConfig testConfig; + + public ApplyBrandToEnvelopeTest() throws IOException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + + this.accountsApi = new AccountsApi(apiClient); + this.envelopesApi = new EnvelopesApi(apiClient); + } + + @Test + public void GetBrands_CorrectInputValues_ReturnsBrandsResponse() throws ApiException { + // Act + BrandsResponse brand = ApplyBrandToEnvelopeService.getBrands( + this.accountsApi, + testConfig.getAccountId()); + + testConfig.setBrand(brand.getBrands().stream().findFirst().get()); + + // Assert + Assert.assertNotNull(brand); + Assert.assertNotNull(brand.getBrands()); + } + + @Test + public void MakeEnvelope_CorrectInputValues_ReturnsEnvelopeDefinition() throws IOException { + // Arrange + String defaultID = "1"; + String emailSubject = "EG029. Please Sign"; + String anchorString = "/sn1/"; + Document document = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, defaultID); + + Tabs tabs = EnvelopeHelpers.createSingleSignerTab(anchorString, ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X); + Signer signer = new Signer() + .email(testConfig.getSignerEmail()) + .name(testConfig.getSignerName()) + .recipientId(defaultID) + .routingOrder(defaultID) + .tabs(tabs); + + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + EnvelopeDefinition expectedEnvelopeDefinition = new EnvelopeDefinition() + .emailSubject(emailSubject) + .documents(List.of(document)) + .recipients(recipients) + .brandId(testConfig.getBrand().getBrandId()) + .status(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + // Act + EnvelopeDefinition envelopeDefinition = ApplyBrandToEnvelopeService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + testConfig.getBrand().getBrandId()); + + // Assert + Assert.assertNotNull(envelopeDefinition); + Assert.assertEquals(expectedEnvelopeDefinition, envelopeDefinition); + } + + @Test + public void ApplyBrandToEnvelope_CorrectInputValues_ReturnsEnvelopeSummary() throws ApiException, IOException { + // Arrange + EnvelopeDefinition envelopeDefinition = ApplyBrandToEnvelopeService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + testConfig.getBrand().getBrandId()); + + // Act + EnvelopeSummary envelopeSummary = ApplyBrandToEnvelopeService.applyBrandToEnvelope( + this.envelopesApi, + testConfig.getAccountId(), + envelopeDefinition); + + // Assert + Assert.assertNotNull(envelopeSummary); + } +} diff --git a/src/test/java/tests/eSignature/BulkSendEnvelopesTest.java b/src/test/java/tests/eSignature/BulkSendEnvelopesTest.java new file mode 100644 index 00000000..151f2200 --- /dev/null +++ b/src/test/java/tests/eSignature/BulkSendEnvelopesTest.java @@ -0,0 +1,294 @@ +package tests.eSignature; + +import com.docusign.controller.eSignature.examples.DsModelUtils; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.controller.eSignature.services.BulkSendEnvelopesService; +import com.docusign.core.model.ApiType; +import com.docusign.esign.api.BulkEnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.util.Collections; +import java.util.List; + +public final class BulkSendEnvelopesTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final long BULK_REQUEST_DELAY = 15L; + + private static final String BULK_SIGNER_EMAIL_PLACEHOLDER = "MultiBulkRecipients-%s@docusign.com"; + + private static final String BULK_SIGNER_NAME_PLACEHOLDER = "Multi Bulk Recipients::%s"; + + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "Lorem Ipsum"; + + private static final int ANCHOR_OFFSET_Y = -5; + + private static final int ANCHOR_OFFSET_X = 15; + + private static final String basePathAddition = "/restapi"; + + private final ApiClient apiClient; + + private final BulkEnvelopesApi bulkEnvelopesApi; + + private final TestConfig testConfig; + + public BulkSendEnvelopesTest() throws IOException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + + this.bulkEnvelopesApi = new BulkEnvelopesApi(apiClient); + } + + @Test + public void CreateCCPlaceholder_CorrectInputValues_ReturnsCarbonCopy() { + // Arrange + String roleName = "cc"; + String routingOrder = "1"; + String recipientId = "1"; + CarbonCopy expectedCarbonCopy = new CarbonCopy() + .name(String.format(BULK_SIGNER_NAME_PLACEHOLDER, roleName)) + .email(String.format(BULK_SIGNER_EMAIL_PLACEHOLDER, roleName)) + .roleName(roleName) + .note("") + .routingOrder(routingOrder) + .status(EnvelopeHelpers.SIGNER_STATUS_CREATED) + .deliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL) + .recipientId(recipientId) + .recipientType(roleName); + + // Act + CarbonCopy carbonCopy = BulkSendEnvelopesService.createCCPlaceholder( + roleName, + recipientId, + routingOrder); + + // Assert + Assert.assertNotNull(carbonCopy); + Assert.assertEquals(expectedCarbonCopy, carbonCopy); + } + + @Test + public void CreateSignerPlaceholder_CorrectInputValues_ReturnsSigner() { + // Arrange + String roleName = "signer"; + String routingOrder = "1"; + String recipientId = "1"; + String anchorString = "/sn1/"; + Signer expectedSigner = new Signer() + .name(String.format(BULK_SIGNER_NAME_PLACEHOLDER, roleName)) + .email(String.format(BULK_SIGNER_EMAIL_PLACEHOLDER, roleName)) + .roleName(roleName) + .note("") + .routingOrder(routingOrder) + .status(EnvelopeHelpers.SIGNER_STATUS_CREATED) + .deliveryMethod(EnvelopeHelpers.DELIVERY_METHOD_EMAIL) + .recipientId(recipientId) + .recipientType(roleName) + .tabs(EnvelopeHelpers.createSingleSignerTab(anchorString, ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X)); + + // Act + Signer signer = BulkSendEnvelopesService.createSignerPlaceholder( + roleName, + recipientId, + routingOrder); + + // Assert + Assert.assertNotNull(signer); + Assert.assertEquals(expectedSigner, signer); + } + + @Test + public void CreateRecipients_CorrectInputValues_ReturnsRecipients() { + // Arrange + String defaultId = "1"; + String defaultIdTwo = "2"; + Signer signer = BulkSendEnvelopesService.createSignerPlaceholder(EnvelopeHelpers.SIGNER_ROLE_NAME, defaultId, defaultId); + CarbonCopy carbonCopy = BulkSendEnvelopesService.createCCPlaceholder(EnvelopeHelpers.CC_ROLE_NAME, defaultIdTwo, defaultIdTwo); + Recipients expectedRecipients = new Recipients() + .signers(List.of(signer)) + .carbonCopies(List.of(carbonCopy)); + + // Act + Recipients recipients = BulkSendEnvelopesService.createRecipients(); + + // Assert + Assert.assertNotNull(recipients); + Assert.assertEquals(expectedRecipients, recipients); + } + + @Test + public void CreateCustomFields_CorrectInputValues_ReturnsCustomFields() { + // Arrange + String bulkListId = "1"; + String mailingListId = "mailingListId"; + TextCustomField textCustomField = new TextCustomField() + .name(mailingListId) + .required(DsModelUtils.FALSE) + .show(DsModelUtils.FALSE) + .value(bulkListId); + + CustomFields expectedCustomFields = new CustomFields() + .listCustomFields(Collections.emptyList()) + .textCustomFields(List.of(textCustomField)); + + // Act + CustomFields customFields = BulkSendEnvelopesService.createCustomFields(bulkListId); + + // Assert + Assert.assertNotNull(customFields); + Assert.assertEquals(expectedCustomFields, customFields); + } + + @Test + public void MakeEnvelope_CorrectInputValues_ReturnsEnvelopeDefinition() throws IOException { + // Arrange + String docId = "1"; + String emailSubject = "EG031 Please sign"; + Document document = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, docId); + EnvelopeDefinition expectedEnvelopeDefinition = new EnvelopeDefinition() + .documents(List.of(document)) + .envelopeIdStamping(DsModelUtils.TRUE) + .emailSubject(emailSubject) + .status(EnvelopeHelpers.ENVELOPE_STATUS_CREATED) + .recipients(BulkSendEnvelopesService.createRecipients()); + + // Act + EnvelopeDefinition envelopeDefinition = BulkSendEnvelopesService.makeEnvelope(); + + // Assert + Assert.assertNotNull(envelopeDefinition); + Assert.assertEquals(expectedEnvelopeDefinition, envelopeDefinition); + } + + @Test + public void CreateBulkSending_CorrectInputValues_ReturnsBulkSendingCopy() { + // Arrange + String ccName = "CC"; + String ccEmail = "cc@gmail.com"; + + BulkSendingCopyRecipient recipient1 = new BulkSendingCopyRecipient() + .name(testConfig.getSignerName()) + .email(testConfig.getSignerEmail()) + .tabs(Collections.emptyList()) + .roleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + + BulkSendingCopyRecipient recipient2 = new BulkSendingCopyRecipient() + .name(ccName) + .email(ccEmail) + .tabs(Collections.emptyList()) + .roleName(EnvelopeHelpers.CC_ROLE_NAME); + + BulkSendingCopy expectedBulkSendingCopy = new BulkSendingCopy() + .recipients(List.of(recipient1, recipient2)) + .customFields(Collections.emptyList()); + + // Act + BulkSendingCopy bulkSendingCopy = BulkSendEnvelopesService.createBulkSending( + testConfig.getSignerName(), + testConfig.getSignerEmail(), + ccName, + ccEmail + ); + + // Assert + Assert.assertNotNull(bulkSendingCopy); + Assert.assertEquals(expectedBulkSendingCopy, bulkSendingCopy); + } + + @Test + public void GetSendingList_CorrectInputValues_ReturnsBulkSendingList() { + // Arrange + String ccName = "CC"; + String ccEmail = "cc@gmail.com"; + String cc2Name = "CC 2"; + String cc2Email = "cc2@gmail.com"; + String signer2Name = "Signer 2"; + String signer2Email = "signer2@gmail.com"; + String fileName = "sample.csv"; + + List copies = List.of( + BulkSendEnvelopesService.createBulkSending(testConfig.getSignerName(), testConfig.getSignerEmail(), ccName, ccEmail), + BulkSendEnvelopesService.createBulkSending(signer2Name, signer2Email, cc2Name, cc2Email) + ); + BulkSendingList expectedBulkSendingList = new BulkSendingList() + .name(fileName) + .bulkCopies(copies); + + // Act + BulkSendingList bulkSendingList = BulkSendEnvelopesService.getSendingList( + testConfig.getSignerName(), + testConfig.getSignerEmail(), + ccName, + ccEmail, + signer2Name, + signer2Email, + cc2Name, + cc2Email + ); + + // Assert + Assert.assertNotNull(bulkSendingList); + Assert.assertEquals(expectedBulkSendingList, bulkSendingList); + } + + @Test + public void BulkSendEnvelopes_CorrectInputValues_ReturnsString() throws ApiException, IOException { + // Arrange + String ccName = "CC"; + String ccEmail = "cc@gmail.com"; + String cc2Name = "CC 2"; + String cc2Email = "cc2@gmail.com"; + String signer2Name = "Signer 2"; + String signer2Email = "signer2@gmail.com"; + + // Act + String batchId = BulkSendEnvelopesService.bulkSendEnvelopes( + this.bulkEnvelopesApi, + this.apiClient, + testConfig.getSignerName(), + testConfig.getSignerEmail(), + ccName, + ccEmail, + signer2Name, + signer2Email, + cc2Name, + cc2Email, + testConfig.getAccountId() + ); + testConfig.setBatchId(batchId); + + // Assert + Assert.assertNotNull(batchId); + } + + @Test + public void GetBulkSendBatchStatus_CorrectInputValues_ReturnsBulkSendBatchStatus() throws ApiException, IOException, InterruptedException { + // Arrange + BulkSendEnvelopes_CorrectInputValues_ReturnsString(); + + // Act + BulkSendBatchStatus bulkSendBatchStatus = BulkSendEnvelopesService.getBulkSendBatchStatus( + this.bulkEnvelopesApi, + testConfig.getAccountId(), + testConfig.getBatchId(), + BULK_REQUEST_DELAY + ); + + // Assert + Assert.assertNotNull(bulkSendBatchStatus); + } +} diff --git a/src/test/java/tests/eSignature/CreateBrandTest.java b/src/test/java/tests/eSignature/CreateBrandTest.java new file mode 100644 index 00000000..bff20e03 --- /dev/null +++ b/src/test/java/tests/eSignature/CreateBrandTest.java @@ -0,0 +1,59 @@ +package tests.eSignature; + +import com.docusign.controller.eSignature.services.CreateBrandService; +import com.docusign.core.model.ApiType; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.BrandsResponse; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.util.Random; + +public final class CreateBrandTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String basePathAddition = "/restapi"; + + private final ApiClient apiClient; + + private final AccountsApi accountsApi; + + private final TestConfig testConfig; + + public CreateBrandTest() throws IOException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + this.accountsApi = new AccountsApi(apiClient); + } + + @Test + public void CreateBrand_CorrectInputValues_ReturnsBrandsResponse() throws ApiException { + // Arrange + byte[] array = new byte[8]; + new Random().nextBytes(array); + var brandName = new String(array, StandardCharsets.UTF_8); + var defaultBrandLanguage = "en"; + + // Act + BrandsResponse brand = CreateBrandService.createBrand( + this.accountsApi, + brandName, + defaultBrandLanguage, + testConfig.getAccountId()); + + // Assert + Assert.assertNotNull(brand); + Assert.assertNotNull(brand.getBrands()); + } +} diff --git a/src/test/java/tests/eSignature/CreateNewTemplateTest.java b/src/test/java/tests/eSignature/CreateNewTemplateTest.java new file mode 100644 index 00000000..c7f96cb7 --- /dev/null +++ b/src/test/java/tests/eSignature/CreateNewTemplateTest.java @@ -0,0 +1,331 @@ +package tests.eSignature; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.controller.eSignature.services.CreateTemplateService; +import com.docusign.core.model.ApiType; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; +import java.util.Locale; + +public final class CreateNewTemplateTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String TEMPLATE_NAME = "Example Signer and CC template v2"; + + private static final String PDF_DOCUMENT_FILE_NAME = "World_Wide_Corp_fields.pdf"; + + private static final String PDF_DOCUMENT_NAME = "Lorem Ipsum"; + + private static final String DOCUMENT_ID = "1"; + + private static final String PAGE_NUMBER = "1"; + + private static final String FALSE = "false"; + + private static final String basePathAddition = "/restapi"; + + private final ApiClient apiClient; + + private final EnvelopesApi envelopesApi; + + private final TestConfig testConfig; + + public CreateNewTemplateTest() throws IOException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + this.envelopesApi = new EnvelopesApi(apiClient); + } + + @Test + public void SearchTemplatesByName_CorrectInputValues_EnvelopeTemplateResults() throws ApiException { + // Act + EnvelopeTemplateResults envelopeTemplateResults = CreateTemplateService.searchTemplatesByName( + apiClient, + testConfig.getAccountId(), + TEMPLATE_NAME); + + // Assert + Assert.assertNotNull(envelopeTemplateResults); + Assert.assertTrue(Integer.parseInt(envelopeTemplateResults.getResultSetSize()) > 0); + + EnvelopeTemplate template = envelopeTemplateResults.getEnvelopeTemplates().get(0); + testConfig.setTemplateId(template.getTemplateId()); + } + + @Test + public void CreateTemplate_CorrectInputValues_TemplateSummary() throws IOException, ApiException { + // Arrange + EnvelopeTemplate envelopeTemplate = CreateTemplateService.makeTemplate(TEMPLATE_NAME); + + // Act + TemplateSummary template = CreateTemplateService.createTemplate( + apiClient, + testConfig.getAccountId(), + envelopeTemplate + ); + + // Assert + Assert.assertNotNull(template); + Assert.assertNotNull(template.getTemplateId()); + + testConfig.setTemplateId(template.getTemplateId()); + } + + @Test + public void MakeRecipientViewRequest_CorrectInputValues_RecipientViewRequest() throws ApiException { + // Act + EnvelopeTemplateResults envelopeTemplateResults = CreateTemplateService.searchTemplatesByName( + apiClient, + testConfig.getAccountId(), + TEMPLATE_NAME); + + // Assert + Assert.assertNotNull(envelopeTemplateResults); + Assert.assertTrue(Integer.parseInt(envelopeTemplateResults.getResultSetSize()) > 0); + + EnvelopeTemplate template = envelopeTemplateResults.getEnvelopeTemplates().get(0); + testConfig.setTemplateId(template.getTemplateId()); + } + + @Test + public void MakeTemplate_CorrectInputValues_EnvelopeTemplate() throws IOException { + // Assert + String defaultIdOne = "1"; + Document doc = EnvelopeHelpers.createDocumentFromFile(PDF_DOCUMENT_FILE_NAME, PDF_DOCUMENT_NAME, defaultIdOne); + String emailSubject = "Please sign this document"; + String description = "Example template created via the API"; + String falseString = "false"; + String textXPosition = "153"; + String checkboxXPosition = "75"; + String defaultIdTwo = "2"; + + Tabs signerTabs = new Tabs(); + signerTabs.setCheckboxTabs(Arrays.asList( + CreateTemplateService.createCheckbox("ckAuthorization", checkboxXPosition, "417"), + CreateTemplateService.createCheckbox("ckAuthentication", checkboxXPosition, "447"), + CreateTemplateService.createCheckbox("ckAgreement", checkboxXPosition, "478"), + CreateTemplateService.createCheckbox("ckAcknowledgement", checkboxXPosition, "508"))); + + signerTabs.setListTabs(Collections.singletonList(CreateTemplateService.createList())); + signerTabs.setRadioGroupTabs(Collections.singletonList(CreateTemplateService.createRadioGroup())); + signerTabs.setSignHereTabs(Collections.singletonList(CreateTemplateService.createSignHere())); + signerTabs.textTabs(java.util.List.of( + CreateTemplateService.createText("text", textXPosition, "230") + )); + signerTabs.numericalTabs(java.util.List.of( + CreateTemplateService.createNumerical("numericalCurrency", textXPosition, "260") + )); + + Signer signer = new Signer(); + signer.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + signer.setRecipientId(defaultIdOne); + signer.setRoutingOrder(defaultIdOne); + signer.setTabs(signerTabs); + + CarbonCopy cc = new CarbonCopy(); + cc.setRoleName(EnvelopeHelpers.CC_ROLE_NAME); + cc.setRoutingOrder(defaultIdTwo); + cc.setRecipientId(defaultIdTwo); + + EnvelopeTemplate expectedEnvelopeTemplate = new EnvelopeTemplate(); + expectedEnvelopeTemplate.setDocuments(Collections.singletonList(doc)); + expectedEnvelopeTemplate.setEmailSubject(emailSubject); + expectedEnvelopeTemplate.setName(TEMPLATE_NAME); + expectedEnvelopeTemplate.setDescription(description); + expectedEnvelopeTemplate.setShared(falseString); + expectedEnvelopeTemplate.setRecipients(EnvelopeHelpers.createRecipients(signer, cc)); + expectedEnvelopeTemplate.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_CREATED); + + // Act + EnvelopeTemplate envelopeTemplate = CreateTemplateService.makeTemplate(TEMPLATE_NAME); + + // Assert + Assert.assertNotNull(envelopeTemplate); + Assert.assertEquals(expectedEnvelopeTemplate, envelopeTemplate); + } + + @Test + public void CreateList_CorrectInputValues_List() { + // Arrange + List expectedList = new List(); + expectedList.setDocumentId(DOCUMENT_ID); + expectedList.setPageNumber(PAGE_NUMBER); + expectedList.setXPosition("142"); + expectedList.setYPosition("291"); + expectedList.setFont("helvetica"); + expectedList.setFontSize("size14"); + expectedList.setTabLabel("list"); + expectedList.setRequired(FALSE); + expectedList.setListItems(Arrays.asList( + CreateTemplateService.createListItem("Red"), + CreateTemplateService.createListItem("Orange"), + CreateTemplateService.createListItem("Yellow"), + CreateTemplateService.createListItem("Green"), + CreateTemplateService.createListItem("Blue"), + CreateTemplateService.createListItem("Indigo"), + CreateTemplateService.createListItem("Violet") + )); + + // Act + List list = CreateTemplateService.createList(); + + // Assert + Assert.assertNotNull(list); + Assert.assertEquals(expectedList, list); + } + + @Test + public void CreateListItem_CorrectInputValues_ListItem() { + // Arrange + String color = "blue"; + + ListItem expectedListItem = new ListItem(); + expectedListItem.setText(color); + expectedListItem.setValue(color.toLowerCase(Locale.ENGLISH)); + + // Act + ListItem listItem = CreateTemplateService.createListItem(color); + + // Assert + Assert.assertNotNull(listItem); + Assert.assertEquals(expectedListItem, listItem); + } + + @Test + public void CreateRadioGroup_CorrectInputValues_RadioGroup() { + // Arrange + String white = "white"; + String red = "red"; + String blue = "blue"; + String blueXPosition = "220"; + String redXPosition = "74"; + String whiteXPosition = "142"; + String groupName = "radio1"; + + RadioGroup expectedRadioGroup = new RadioGroup(); + expectedRadioGroup.setDocumentId(DOCUMENT_ID); + expectedRadioGroup.setGroupName(groupName); + + expectedRadioGroup.setRadios(Arrays.asList( + CreateTemplateService.createRadio(white, whiteXPosition), + CreateTemplateService.createRadio(red, redXPosition), + CreateTemplateService.createRadio(blue, blueXPosition) + )); + + // Act + RadioGroup radioGroup = CreateTemplateService.createRadioGroup(); + + // Assert + Assert.assertNotNull(radioGroup); + Assert.assertEquals(expectedRadioGroup, radioGroup); + } + + @Test + public void CreateRadio_CorrectInputValues_Radio() { + // Arrange + String value = "blue"; + String xPosition = "111"; + String yPosition = "384"; + + Radio expectedRadio = new Radio(); + expectedRadio.setPageNumber(PAGE_NUMBER); + expectedRadio.setValue(value); + expectedRadio.setXPosition(xPosition); + expectedRadio.setYPosition(yPosition); + expectedRadio.setRequired(FALSE); + + // Act + Radio radio = CreateTemplateService.createRadio(value, xPosition); + + // Assert + Assert.assertNotNull(radio); + Assert.assertEquals(expectedRadio, radio); + } + + @Test + public void CreateCheckbox_CorrectInputValues_Checkbox() { + // Arrange + String label = "blue"; + String yPosition = "111"; + String xPosition = "111"; + + Checkbox expectedCheckBox = new Checkbox(); + expectedCheckBox.setDocumentId(DOCUMENT_ID); + expectedCheckBox.setPageNumber(PAGE_NUMBER); + expectedCheckBox.setXPosition(xPosition); + expectedCheckBox.setYPosition(yPosition); + expectedCheckBox.setTabLabel(label); + + // Act + Checkbox check = CreateTemplateService.createCheckbox(label, xPosition, yPosition); + + // Assert + Assert.assertNotNull(check); + Assert.assertEquals(expectedCheckBox, check); + } + + @Test + public void CreateText_CorrectInputValues_Text() { + // Arrange + String xPosition = "1"; + String yPosition = "5"; + String label = "blue"; + String font = "helvetica"; + String fontSize = "size14"; + String height = "23"; + String width = "84"; + + Text expectedText = new Text(); + expectedText.setDocumentId(DOCUMENT_ID); + expectedText.setPageNumber(PAGE_NUMBER); + expectedText.setXPosition(xPosition); + expectedText.setYPosition(yPosition); + expectedText.setFont(font); + expectedText.setFontSize(fontSize); + expectedText.setTabLabel(label); + expectedText.setHeight(height); + expectedText.setWidth(width); + expectedText.setRequired(FALSE); + + // Act + Text text = CreateTemplateService.createText(label, xPosition, yPosition); + + // Assert + Assert.assertNotNull(text); + Assert.assertEquals(expectedText, text); + } + + @Test + public void CreateSignHere_CorrectInputValues_SignHere() { + // Arrange + String xPosition = "191"; + String yPosition = "148"; + + SignHere expectedSignHere = new SignHere(); + expectedSignHere.setDocumentId(DOCUMENT_ID); + expectedSignHere.setPageNumber(PAGE_NUMBER); + expectedSignHere.setXPosition(xPosition); + expectedSignHere.setYPosition(yPosition); + + // Act + SignHere signHere = CreateTemplateService.createSignHere(); + + // Assert + Assert.assertNotNull(signHere); + Assert.assertEquals(expectedSignHere, signHere); + } +} diff --git a/src/test/java/tests/eSignature/EmbeddedSigningTest.java b/src/test/java/tests/eSignature/EmbeddedSigningTest.java new file mode 100644 index 00000000..d029cfaf --- /dev/null +++ b/src/test/java/tests/eSignature/EmbeddedSigningTest.java @@ -0,0 +1,166 @@ +package tests.eSignature; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.controller.eSignature.services.EmbeddedSigningService; +import com.docusign.core.model.ApiType; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.util.Collections; + +public final class EmbeddedSigningTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String DOCUMENT_NAME = "Lorem Ipsum"; + + private static final int ANCHOR_OFFSET_Y = 20; + + private static final int ANCHOR_OFFSET_X = 10; + + private static final String SIGNER_CLIENT_ID = "1000"; + + private static final String basePathAddition = "/restapi"; + + private final String RedirectUrl = "https://developers.docusign.com/platform/auth/consent"; + + private final ApiClient apiClient; + + private final TestConfig testConfig; + + public EmbeddedSigningTest() throws IOException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + } + + @Test + public void MakeEnvelope_CorrectInputValues_EnvelopeDefinition() throws IOException { + // Arrange + String anchorString = "/sn1/"; + String emailSubject = "Please sign this document"; + String docId = "3"; + String recipientId = "1"; + EnvelopeDefinition expectedEnvelopeDefinition = new EnvelopeDefinition(); + + Signer signer = new Signer(); + signer.setEmail(testConfig.getSignerEmail()); + signer.setName(testConfig.getSignerName()); + signer.clientUserId(SIGNER_CLIENT_ID); + signer.recipientId(recipientId); + signer.setTabs(EnvelopeHelpers.createSingleSignerTab(anchorString, ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X)); + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + expectedEnvelopeDefinition.setEmailSubject(emailSubject); + expectedEnvelopeDefinition.setRecipients(recipients); + Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, docId); + expectedEnvelopeDefinition.setDocuments(Collections.singletonList(doc)); + expectedEnvelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + // Act + EnvelopeDefinition envelopeDefinition = EmbeddedSigningService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID, + ANCHOR_OFFSET_Y, + ANCHOR_OFFSET_X, + DOCUMENT_FILE_NAME, + DOCUMENT_NAME); + + // Assert + Assert.assertNotNull(envelopeDefinition); + Assert.assertEquals(expectedEnvelopeDefinition, envelopeDefinition); + } + + @Test + public void MakeRecipientViewRequest_CorrectInputValues_RecipientViewRequest() { + //Arrange + RecipientViewRequest expectedViewRequest = new RecipientViewRequest(); + String stateValue = "?state=123"; + String authenticationMethod = "none"; + String pingFrequency = "600"; + + expectedViewRequest.setReturnUrl(RedirectUrl + stateValue); + expectedViewRequest.setAuthenticationMethod(authenticationMethod); + expectedViewRequest.setEmail(testConfig.getSignerEmail()); + expectedViewRequest.setUserName(testConfig.getSignerName()); + expectedViewRequest.setClientUserId(SIGNER_CLIENT_ID); + expectedViewRequest.setPingFrequency(pingFrequency); + expectedViewRequest.setPingUrl(RedirectUrl); + + // Act + RecipientViewRequest viewRequest = EmbeddedSigningService.makeRecipientViewRequest( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID, + RedirectUrl, + RedirectUrl); + + // Assert + Assert.assertNotNull(viewRequest); + Assert.assertEquals(expectedViewRequest, viewRequest); + } + + @Test + public void CreateEnvelope_CorrectInputValues_EnvelopeId() throws IOException, ApiException { + //Arrange + EnvelopeDefinition envelope = EmbeddedSigningService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID, + ANCHOR_OFFSET_Y, + ANCHOR_OFFSET_X, + DOCUMENT_FILE_NAME, + DOCUMENT_NAME); + + // Act + String envelopeId = EmbeddedSigningService.createEnvelope(apiClient, testConfig.getAccountId(), envelope); + + // Assert + Assert.assertNotNull(envelopeId); + } + + @Test + public void EmbeddedSigning_CorrectInputValues_ViewUrl() throws IOException, ApiException { + //Arrange + EnvelopeDefinition envelope = EmbeddedSigningService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID, + ANCHOR_OFFSET_Y, + ANCHOR_OFFSET_X, + DOCUMENT_FILE_NAME, + DOCUMENT_NAME); + + String envelopeId = EmbeddedSigningService.createEnvelope(apiClient, testConfig.getAccountId(), envelope); + + RecipientViewRequest viewRequest = EmbeddedSigningService.makeRecipientViewRequest( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + SIGNER_CLIENT_ID, + RedirectUrl, + RedirectUrl); + + // Act + ViewUrl viewUrl = EmbeddedSigningService.embeddedSigning( + apiClient, + testConfig.getAccountId(), + envelopeId, + viewRequest + ); + + // Assert + Assert.assertNotNull(viewUrl); + } +} diff --git a/src/test/java/tests/eSignature/PermissionCreateTest.java b/src/test/java/tests/eSignature/PermissionCreateTest.java new file mode 100644 index 00000000..fcea85aa --- /dev/null +++ b/src/test/java/tests/eSignature/PermissionCreateTest.java @@ -0,0 +1,57 @@ +package tests.eSignature; + +import com.docusign.controller.eSignature.services.PermissionCreateService; +import com.docusign.core.model.ApiType; +import com.docusign.esign.api.AccountsApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.PermissionProfile; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.util.Random; + +public final class PermissionCreateTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String basePathAddition = "/restapi"; + + private final ApiClient apiClient; + + private final AccountsApi accountsApi; + + private final TestConfig testConfig; + + public PermissionCreateTest() throws IOException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + this.accountsApi = new AccountsApi(apiClient); + } + + @Test + public void CreateNewProfile_CorrectInputValues_ReturnsPermissionProfile() throws ApiException { + // Arrange + byte[] byteArray = new byte[8]; + new Random().nextBytes(byteArray); + var permissionName = new String(byteArray, StandardCharsets.UTF_8); + + // Act + PermissionProfile permissionProfile = PermissionCreateService.createNewProfile( + this.accountsApi, + testConfig.getAccountId(), + permissionName); + + // Assert + Assert.assertNotNull(permissionProfile); + Assert.assertEquals(permissionName, permissionProfile.getPermissionProfileName()); + } +} diff --git a/src/test/java/tests/eSignature/SetTabValuesTest.java b/src/test/java/tests/eSignature/SetTabValuesTest.java new file mode 100644 index 00000000..498b06e8 --- /dev/null +++ b/src/test/java/tests/eSignature/SetTabValuesTest.java @@ -0,0 +1,256 @@ +package tests.eSignature; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.controller.eSignature.services.SetTabValuesService; +import com.docusign.core.model.ApiType; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; + +public final class SetTabValuesTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String DOCUMENT_FILE_NAME = "World_Wide_Corp_salary.docx"; + + private static final String DOCUMENT_NAME = "Lorem Ipsum"; + + private static final String SIGNER_CLIENT_ID = "1000"; + + private static final String basePathAddition = "/restapi"; + + private final String RedirectUrl = "https://developers.docusign.com/platform/auth/consent"; + + private final ApiClient apiClient; + + private final EnvelopesApi envelopesApi; + + private final TestConfig testConfig; + + public SetTabValuesTest() throws IOException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + this.envelopesApi = new EnvelopesApi(apiClient); + } + + @Test + public void MakeEnvelopeWithTabValues_CorrectInputValues_EnvelopeDefinition() throws IOException { + // Arrange + String emailSubject = "Please sign this document from the Java SDK"; + String initialId = "1"; + Integer salary = 123000; + String salaryString = "salary"; + String fontSize = "size11"; + String font = "helvetica"; + String trueString = "true"; + String falseString = "false"; + + Signer signer = new Signer(); + signer.setEmail(testConfig.getSignerEmail()); + signer.setName(testConfig.getSignerName()); + signer.clientUserId(SIGNER_CLIENT_ID); + signer.recipientId(initialId); + + SignHere signHere = new SignHere(); + signHere.setAnchorString("/sn1"); + signHere.setAnchorUnits("pixels"); + signHere.setAnchorYOffset("10"); + signHere.setAnchorXOffset("20"); + + Text textLegal = new Text(); + textLegal.setAnchorString("/legal/"); + textLegal.setAnchorUnits("pixels"); + textLegal.setAnchorYOffset("-9"); + textLegal.setAnchorXOffset("5"); + textLegal.setFont(font); + textLegal.setFontSize(fontSize); + textLegal.setBold(trueString); + textLegal.setValue(testConfig.getSignerName()); + textLegal.setLocked(falseString); + textLegal.setTabId("legal_name"); + textLegal.setTabLabel("Legal Name"); + + Text textFamiliar = new Text(); + textFamiliar.setAnchorString("/familiar/"); + textFamiliar.setAnchorUnits("pixels"); + textFamiliar.setAnchorYOffset("-9"); + textFamiliar.setAnchorXOffset("5"); + textFamiliar.setFont(font); + textFamiliar.setFontSize(fontSize); + textFamiliar.setBold(trueString); + textFamiliar.setValue(testConfig.getSignerName()); + textFamiliar.setLocked(falseString); + textFamiliar.setTabId("familiar_name"); + textFamiliar.setTabLabel("Familiar Name"); + + Numerical numericalSalary = new Numerical(); + numericalSalary.setValidationType("Currency"); + numericalSalary.setPageNumber(initialId); + numericalSalary.setDocumentId(initialId); + numericalSalary.setXPosition("210"); + numericalSalary.setYPosition("235"); + numericalSalary.setHeight("20"); + numericalSalary.setWidth("70"); + numericalSalary.setFont(font); + numericalSalary.setFontSize(fontSize); + numericalSalary.setBold(trueString); + numericalSalary.setNumericalValue(String.format("%d", salary)); + numericalSalary.setTabId(salaryString); + numericalSalary.setTabLabel(salaryString); + + LocalePolicyTab localePolicyTab = new LocalePolicyTab(); + localePolicyTab.setCultureName("en-US"); + localePolicyTab.setCurrencyCode("usd"); + localePolicyTab.setCurrencyPositiveFormat("csym_1_comma_234_comma_567_period_89"); + localePolicyTab.setCurrencyNegativeFormat("minus_csym_1_comma_234_comma_567_period_89"); + localePolicyTab.setUseLongCurrencyFormat(trueString); + numericalSalary.setLocalePolicy(localePolicyTab); + + TextCustomField salaryCustomField = new TextCustomField(); + salaryCustomField.setName(salaryString); + salaryCustomField.setRequired(falseString); + salaryCustomField.setShow(trueString); + salaryCustomField.setValue(String.valueOf(salary)); + CustomFields cf = new CustomFields(); + cf.setTextCustomFields(Collections.singletonList(salaryCustomField)); + + Tabs tabs = new Tabs(); + tabs.setSignHereTabs(Collections.singletonList(signHere)); + tabs.setTextTabs(Arrays.asList(textLegal, textFamiliar)); + tabs.setNumericalTabs(List.of(numericalSalary)); + + signer.setTabs(tabs); + Recipients recipients = new Recipients(); + recipients.setSigners(Collections.singletonList(signer)); + + EnvelopeDefinition expectedEnvelopeDefinition = new EnvelopeDefinition(); + expectedEnvelopeDefinition.setEmailSubject(emailSubject); + expectedEnvelopeDefinition.setRecipients(recipients); + Document doc = EnvelopeHelpers.createDocumentFromFile(DOCUMENT_FILE_NAME, DOCUMENT_NAME, initialId); + expectedEnvelopeDefinition.setDocuments(Collections.singletonList(doc)); + expectedEnvelopeDefinition.setCustomFields(cf); + expectedEnvelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + // Act + EnvelopeDefinition envelopeDefinition = SetTabValuesService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName()); + + // Assert + Assert.assertNotNull(envelopeDefinition); + Assert.assertEquals(expectedEnvelopeDefinition, envelopeDefinition); + } + + @Test + public void SetEmailAndSignerNameForRecipientViewRequest_CorrectInputValues_RecipientViewRequest() { + //Arrange + RecipientViewRequest expectedViewRequest = new RecipientViewRequest(); + String authenticationMethod = "none"; + String pingFrequency = "600"; + expectedViewRequest.setAuthenticationMethod(authenticationMethod); + expectedViewRequest.setEmail(testConfig.getSignerEmail()); + expectedViewRequest.setUserName(testConfig.getSignerName()); + expectedViewRequest.setClientUserId(SIGNER_CLIENT_ID); + expectedViewRequest.setPingFrequency(pingFrequency); + expectedViewRequest.setPingUrl(RedirectUrl); + + // Act + RecipientViewRequest viewRequest = SetTabValuesService.setEmailAndSignerNameForRecipientViewRequest( + new RecipientViewRequest(), + testConfig.getSignerEmail(), + testConfig.getSignerName(), + RedirectUrl); + + // Assert + Assert.assertNotNull(viewRequest); + Assert.assertEquals(expectedViewRequest, viewRequest); + } + + @Test + public void MakeRecipientViewRequest_CorrectInputValues_RecipientViewRequest() { + //Arrange + RecipientViewRequest expectedViewRequest = new RecipientViewRequest(); + String state = "?state=123"; + String pingFrequency = "600"; + String authenticationMethod = "none"; + + expectedViewRequest.setReturnUrl(RedirectUrl + state); + expectedViewRequest.setAuthenticationMethod(authenticationMethod); + expectedViewRequest.setEmail(testConfig.getSignerEmail()); + expectedViewRequest.setUserName(testConfig.getSignerName()); + expectedViewRequest.setClientUserId(SIGNER_CLIENT_ID); + expectedViewRequest.setPingFrequency(pingFrequency); + expectedViewRequest.setPingUrl(RedirectUrl); + + // Act + RecipientViewRequest viewRequest = SetTabValuesService.makeRecipientViewRequest( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + RedirectUrl, + RedirectUrl); + + // Assert + Assert.assertNotNull(viewRequest); + Assert.assertEquals(expectedViewRequest, viewRequest); + } + + @Test + public void CreateEnvelope_CorrectInputValues_EnvelopeSummary() throws IOException, ApiException { + //Arrange + EnvelopeDefinition envelope = SetTabValuesService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName()); + + // Act + EnvelopeSummary envelopeSummary = SetTabValuesService.createEnvelope( + envelopesApi, + testConfig.getAccountId(), + envelope); + + // Assert + Assert.assertNotNull(envelopeSummary); + Assert.assertNotNull(envelopeSummary.getEnvelopeId()); + } + + @Test + public void CreateRecipientView_CorrectInputValues_ViewUrl() throws IOException, ApiException { + //Arrange + EnvelopeDefinition envelope = SetTabValuesService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName()); + + EnvelopeSummary envelopeSummary = SetTabValuesService.createEnvelope( + envelopesApi, + testConfig.getAccountId(), + envelope); + + RecipientViewRequest viewRequest = SetTabValuesService.makeRecipientViewRequest( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + RedirectUrl, + RedirectUrl); + + // Act + ViewUrl viewUrl = SetTabValuesService.createRecipientView( + envelopesApi, + testConfig.getAccountId(), + envelopeSummary.getEnvelopeId(), + viewRequest); + + // Assert + Assert.assertNotNull(viewUrl); + } +} diff --git a/src/test/java/tests/eSignature/SigningViaEmailTest.java b/src/test/java/tests/eSignature/SigningViaEmailTest.java new file mode 100644 index 00000000..4451a34a --- /dev/null +++ b/src/test/java/tests/eSignature/SigningViaEmailTest.java @@ -0,0 +1,147 @@ +package tests.eSignature; + +import com.docusign.common.WorkArguments; +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.controller.eSignature.services.SigningViaEmailService; +import com.docusign.core.common.DocumentType; +import com.docusign.core.model.ApiType; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.*; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.Arrays; + +public final class SigningViaEmailTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String HTML_DOCUMENT_FILE_NAME = "templates/candy-bonbon.ftl"; + + private static final String HTML_DOCUMENT_NAME = "Order acknowledgement"; + + private static final String PDF_DOCUMENT_FILE_NAME = "World_Wide_Corp_lorem.pdf"; + + private static final String PDF_DOCUMENT_NAME = "Lorem Ipsum"; + + private static final String DOCX_DOCUMENT_FILE_NAME = "World_Wide_Corp_Battle_Plan_Trafalgar.docx"; + + private static final String DOCX_DOCUMENT_NAME = "Battle Plan"; + + private static final int ANCHOR_OFFSET_Y = 10; + + private static final int ANCHOR_OFFSET_X = 20; + + private static final String basePathAddition = "/restapi"; + + private final ApiClient apiClient; + + private final EnvelopesApi envelopesApi; + + private final TestConfig testConfig; + + public SigningViaEmailTest() throws IOException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + this.envelopesApi = new EnvelopesApi(apiClient); + } + + @Test + public void MakeEnvelopeWithCC_CorrectInputValues_EnvelopeDefinition() throws IOException { + // Arrange + String ccEmail = "cc@gmail.com"; + String ccName = "cc"; + String anchorStringOne = "**signature_1**"; + String anchorStringTwo = "/sn1/"; + String emailSubject = "Please sign this document set"; + String defaultIdOne = "1"; + String defaultIdTwo = "2"; + String defaultIdThree = "3"; + WorkArguments args = new WorkArguments(); + args.setSignerEmail(testConfig.getSignerEmail()); + args.setSignerName(testConfig.getSignerName()); + args.setCcEmail(ccEmail); + args.setCcName(ccName); + + Tabs signerTabs = EnvelopeHelpers.createSignerTabs( + EnvelopeHelpers.createSignHere(anchorStringOne, ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X), + EnvelopeHelpers.createSignHere(anchorStringTwo, ANCHOR_OFFSET_Y, ANCHOR_OFFSET_X)); + Signer signer = new Signer(); + signer.setEmail(testConfig.getSignerEmail()); + signer.setName(testConfig.getSignerName()); + signer.setRecipientId(defaultIdOne); + signer.setRoutingOrder(defaultIdOne); + signer.setTabs(signerTabs); + + CarbonCopy cc = new CarbonCopy(); + cc.setEmail(ccEmail); + cc.setName(ccName); + cc.setRecipientId(defaultIdTwo); + cc.setRoutingOrder(defaultIdTwo); + + byte[] htmlDocument = EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args) + .getBytes(StandardCharsets.UTF_8); + EnvelopeDefinition expectedEnvelopeDefinition = new EnvelopeDefinition(); + expectedEnvelopeDefinition.setEmailSubject(emailSubject); + expectedEnvelopeDefinition.setDocuments(Arrays.asList( + EnvelopeHelpers.createDocument(htmlDocument, HTML_DOCUMENT_NAME, + DocumentType.HTML.getDefaultFileExtention(), defaultIdOne), + EnvelopeHelpers.createDocumentFromFile(DOCX_DOCUMENT_FILE_NAME, DOCX_DOCUMENT_NAME, defaultIdTwo), + EnvelopeHelpers.createDocumentFromFile(PDF_DOCUMENT_FILE_NAME, PDF_DOCUMENT_NAME, defaultIdThree))); + expectedEnvelopeDefinition.setRecipients(EnvelopeHelpers.createRecipients(signer, cc)); + expectedEnvelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + // Act + EnvelopeDefinition envelopeDefinition = SigningViaEmailService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + ccEmail, + ccName, + EnvelopeHelpers.ENVELOPE_STATUS_SENT, + args + ); + + // Assert + Assert.assertNotNull(envelopeDefinition); + Assert.assertEquals(expectedEnvelopeDefinition, envelopeDefinition); + } + + @Test + public void SigningViaEmail_CorrectInputValues_EnvelopeSummary() throws IOException, ApiException { + //Arrange + String ccEmail = "cc@gmail.com"; + String ccName = "cc"; + WorkArguments args = new WorkArguments(); + args.setSignerEmail(testConfig.getSignerEmail()); + args.setSignerName(testConfig.getSignerName()); + args.setCcEmail(ccEmail); + args.setCcName(ccName); + + EnvelopeDefinition envelope = SigningViaEmailService.makeEnvelope( + testConfig.getSignerEmail(), + testConfig.getSignerName(), + ccEmail, + ccName, + EnvelopeHelpers.ENVELOPE_STATUS_SENT, + args + ); + + // Act + EnvelopeSummary envelopeSummary = SigningViaEmailService.signingViaEmail( + envelopesApi, + testConfig.getAccountId(), + envelope); + + // Assert + Assert.assertNotNull(envelopeSummary); + } +} diff --git a/src/test/java/tests/eSignature/UseTemplateTest.java b/src/test/java/tests/eSignature/UseTemplateTest.java new file mode 100644 index 00000000..49cb4cdf --- /dev/null +++ b/src/test/java/tests/eSignature/UseTemplateTest.java @@ -0,0 +1,112 @@ +package tests.eSignature; + +import com.docusign.controller.eSignature.examples.EnvelopeHelpers; +import com.docusign.controller.eSignature.services.UseTemplateService; +import com.docusign.core.model.ApiType; +import com.docusign.esign.api.EnvelopesApi; +import com.docusign.esign.client.ApiClient; +import com.docusign.esign.client.ApiException; +import com.docusign.esign.model.EnvelopeDefinition; +import com.docusign.esign.model.EnvelopeSummary; +import com.docusign.esign.model.EnvelopeTemplateResults; +import com.docusign.esign.model.TemplateRole; +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpHeaders; +import tests.common.JWTLoginMethodTest; +import tests.common.TestConfig; + +import java.io.IOException; +import java.util.Arrays; + +public final class UseTemplateTest { + private static final String BEARER_AUTHENTICATION = "Bearer "; + + private static final String basePathAddition = "/restapi"; + + private final ApiClient apiClient; + + private final EnvelopesApi envelopesApi; + + private final TestConfig testConfig; + + public UseTemplateTest() throws IOException, ApiException { + JWTLoginMethodTest.RequestJWTUserToken_CorrectInputValues_ReturnOAuthToken(ApiType.ESIGNATURE); + this.testConfig = TestConfig.getInstance(); + + this.apiClient = new ApiClient(testConfig.getBasePath() + basePathAddition); + apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + testConfig.getAccessToken()); + this.envelopesApi = new EnvelopesApi(apiClient); + + CreateNewTemplateTest createNewTemplateTest = new CreateNewTemplateTest(); + createNewTemplateTest.CreateTemplate_CorrectInputValues_TemplateSummary(); + } + + @Test + public void ListTemplates_CorrectInputValues_EnvelopeTemplateResults() throws ApiException { + // Act + EnvelopeTemplateResults templates = UseTemplateService.listTemplates(apiClient, testConfig.getAccountId()); + + // Assert + Assert.assertNotNull(templates); + } + + @Test + public void MakeEnvelopeFromTemplate_CorrectInputValues_EnvelopeDefinition() { + // Arrange + String ccEmail = "cc@gmail.com"; + String ccName = "cc"; + TemplateRole signer = new TemplateRole(); + signer.setEmail(testConfig.getSignerEmail()); + signer.setName(testConfig.getSignerName()); + signer.setRoleName(EnvelopeHelpers.SIGNER_ROLE_NAME); + + TemplateRole cc = new TemplateRole(); + cc.setEmail(ccEmail); + cc.setName(ccName); + cc.setRoleName(EnvelopeHelpers.CC_ROLE_NAME); + + EnvelopeDefinition expectedEnvelopeDefinition = new EnvelopeDefinition(); + expectedEnvelopeDefinition.setTemplateId(testConfig.getTemplateId()); + expectedEnvelopeDefinition.setTemplateRoles(Arrays.asList(signer, cc)); + expectedEnvelopeDefinition.setStatus(EnvelopeHelpers.ENVELOPE_STATUS_SENT); + + // Act + EnvelopeDefinition envelopeDefinition = UseTemplateService.makeEnvelope( + testConfig.getSignerName(), + testConfig.getSignerEmail(), + ccEmail, + ccName, + testConfig.getTemplateId() + ); + + // Assert + Assert.assertNotNull(envelopeDefinition); + Assert.assertEquals(expectedEnvelopeDefinition, envelopeDefinition); + } + + @Test + public void CreateEnvelopeTemplate_CorrectInputValues_EnvelopeSummary() throws ApiException { + // Arrange + String ccEmail = "cc@gmail.com"; + String ccName = "cc"; + + EnvelopeDefinition envelopeDefinition = UseTemplateService.makeEnvelope( + testConfig.getSignerName(), + testConfig.getSignerEmail(), + ccEmail, + ccName, + testConfig.getTemplateId() + ); + + // Act + EnvelopeSummary envelopeSummary = UseTemplateService.createEnvelopeTemplate( + envelopesApi, + testConfig.getAccountId(), + envelopeDefinition); + + // Assert + Assert.assertNotNull(envelopeSummary); + Assert.assertNotNull(envelopeSummary.getEnvelopeId()); + } +}