Merged master

Author: annahileta

.gitignore

@@ -263,4 +263,5 @@ __pycache__/
 #configuration files (secrets), should not be checked in to source control
 appsettings.json
 private.key
-app.config
+app.config
+web-form-config.json

ExamplesAPIType.cs

@@ -43,6 +43,12 @@ public enum ExamplesApiType
         /// </summary>
         [Description("con")]
         Connect = 5,
+
+        /// <summary>
+        /// Web Forms API
+        /// </summary>
+        [Description("web")]
+        WebForms = 6,
     }
 
     public static class ExamplesApiTypeExtensions

JWTAuth.cs

@@ -78,6 +78,13 @@ public static OAuthToken AuthenticateWithJwt(string api, string clientId, string
                 });
             }
 
+            if (apiType == ExamplesApiType.WebForms)
+            {
+                scopes.Add("webforms_read");
+                scopes.Add("webforms_instance_write");
+                scopes.Add("webforms_instance_read");
+            }
+
             return docuSignClient.RequestJWTUserToken(
                 clientId,
                 impersonatedUserId,

README.md

@@ -54,6 +54,15 @@ For information about the scopes used for obtaining authorization to use the Adm
 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.
 
 
+## Web Forms API
+
+The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact [DocuSign Support](https://support.docusign.com/) or your account manager to find out whether the Web Forms API is available for your production account plan.
+
+For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/web-forms-api/plan-integration/authentication/).
+
+For a list of code examples that use the Web Forms API, see the [How-to guides overview](https://developers.docusign.com/docs/web-forms-api/how-to/) on the DocuSign Developer Center.
+
+
 ## Installation
 
 ### Prerequisites

azure-pipelines.yml

@@ -0,0 +1,120 @@
+# 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: csharp_dockerfile
+  displayName: 'download Dockerfile'
+  inputs:
+    secureFile: 'csharp.Dockerfile'
+
+- script: |
+    echo "place csharp.Dockerfile"
+    echo $(csharp_dockerfile.secureFilePath)
+    cp $(csharp_Dockerfile.secureFilePath) code-examples-csharp-private/Dockerfile
+  displayName: 'place Dockerfile'
+
+- script: |
+    allure –-version
+    java --version
+    javac --version
+    mvn --version
+    docker --version
+
+- task: DownloadSecureFile@1
+  name: csharp_config_properties
+  displayName: 'download config.properties'
+  inputs:
+    secureFile: 'csharp.config.properties'
+
+
+- script: |
+    echo "place config.properties"
+    echo $(csharp_config_properties.secureFilePath)
+    cp $(csharp_config_properties.secureFilePath) launcher-automation/src/main/resources/config.properties
+  displayName: 'place config.properties'
+
+- task: DownloadSecureFile@1
+  name: csharp_appsettings
+  displayName: 'download appsettings.json'
+  inputs:
+    secureFile: 'csharp.appsettings.json'
+
+
+- script: |
+    echo "place appsettings.json"
+    cp $(csharp_appsettings.secureFilePath) code-examples-csharp-private/launcher-csharp/appsettings.json
+  displayName: 'place appsettings.json'
+
+
+- task: DownloadSecureFile@1
+  name: csharp_private_key
+  displayName: 'download private.key'
+  inputs:
+    secureFile: 'private.key'
+
+
+- script: |
+    echo "place private.key"
+    cp $(csharp_private_key.secureFilePath) code-examples-csharp-private/launcher-csharp/private.key
+  displayName: 'place private.key'
+
+- script: dir $(Build.SourcesDirectory)
+
+- script: dir $(Build.SourcesDirectory)/code-examples-csharp-private
+
+- task: Docker@2
+  displayName: Build csharp image
+  inputs:
+    command: build
+    repository: 'launcher-automation-csharp'
+    dockerfile: '$(Build.SourcesDirectory)/code-examples-csharp-private/Dockerfile'
+    buildContext: '$(Build.SourcesDirectory)/code-examples-csharp-private '
+    tags: |
+      latest
+
+- script: |
+    docker run -p 44333:44333 -d launcher-automation-csharp:latest
+  displayName: 'start csharp app'
+
+- script: |
+    cd launcher-automation
+    mvn clean test -DsuiteXmlFile="csharp_suite.xml"
+  displayName: 'C# app tests'
+
+- script: |
+    docker stop $(docker ps -a -q)
+    docker rm $(docker ps -a -q)
+  displayName: 'stop csharp app'
+
+- script: |
+    allure generate --clean --output $(Build.SourcesDirectory)/csharp-allure-output '$(Build.SourcesDirectory)/launcher-automation/target/allure-results'
+  displayName: generate allure html reports
+
+- task: PublishAllureReport@1
+  displayName: 'Publish Allure Report'
+  inputs:
+    reportDir: '$(Build.SourcesDirectory)/csharp-allure-output'

launcher-csharp.Tests/JwtLoginMethodUnitTest.cs

@@ -92,6 +92,9 @@ private string BuildConsentUrl(ExamplesApiType apiType, TestConfig testConfig)
                 scopes += "%20user_read%20user_write%20organization_read%20account_read%20group_read%20"
                             + "permission_read%20identity_provider_read%20domain_read%20user_data_redact%20"
                             + "asset_group_account_read%20asset_group_account_clone_write%20asset_group_account_clone_read";
+            } else if (apiType == ExamplesApiType.WebForms)
+            {
+                scopes += "%20webforms_manage";
             }
 
             string caret = "";

launcher-csharp/Common/IRequestItemsService.cs

@@ -34,6 +34,8 @@ public interface IRequestItemsService
 
         public string TemplateId { get; set; }
 
+        public string WebFormsTemplateId { get; set; }
+
         public string WorkflowId { get; set; }
 
         public bool IsWorkflowPublished { get; set; }

launcher-csharp/Common/LocalsFilter.cs

@@ -98,6 +98,7 @@ public void OnActionExecuting(ActionExecutingContext context)
                         RoomsApiBasePath = this.configuration["DocuSign:RoomsApiEndpoint"],
                         AdminApiBasePath = this.configuration["DocuSign:AdminApiEndpoint"],
                         MaestroApiBasePath = this.configuration["DocuSign:MaestroApiEndpoint"],
+                        WebFormsBasePath = this.configuration["DocuSign:WebFormsBasePath"],
                     }
                     :
                     new Session
@@ -108,6 +109,7 @@ public void OnActionExecuting(ActionExecutingContext context)
                         RoomsApiBasePath = this.configuration["DocuSign:RoomsApiEndpoint"],
                         AdminApiBasePath = this.configuration["DocuSign:AdminApiEndpoint"],
                         MaestroApiBasePath = this.configuration["DocuSign:MaestroApiEndpoint"],
+                        WebFormsBasePath = this.configuration["DocuSign:WebFormsBasePath"],
                     };
 
                 this.requestItemsService.Session = locals.Session;

launcher-csharp/Common/RequestItemsService.cs

@@ -166,6 +166,12 @@ public string InstanceId
             set => this.cache.Set(this.GetKey("InstanceId"), value);
         }
 
+        public string WebFormsTemplateId
+        {
+            get => this.cache.Get<string>(this.GetKey("WebFormsTemplateId"));
+            set => this.cache.Set(this.GetKey("WebFormsTemplateId"), value);
+        }
+
         public string ClickwrapId
         {
             get => this.cache.Get<string>(this.GetKey("ClickwrapId"));
@@ -224,6 +230,7 @@ public void UpdateUserFromJwt()
                 BasePath = account.BaseUri,
                 RoomsApiBasePath = this.Configuration["DocuSign:RoomsApiEndpoint"],
                 AdminApiBasePath = this.Configuration["DocuSign:AdminApiEndpoint"],
+                WebFormsBasePath = this.Configuration["DocuSign:WebFormsBasePath"],
                 MaestroApiBasePath = this.Configuration["DocuSign:MaestroApiEndpoint"],
             };
         }
@@ -278,6 +285,10 @@ public string IdentifyApiOfCodeExample(string eg)
             {
                 currentApiType = ExamplesApiType.Maestro.ToString();
             }
+            else if (eg.Contains(ExamplesApiType.WebForms.ToKeywordString()))
+            {
+                currentApiType = ExamplesApiType.WebForms.ToString();
+            }
             else
             {
                 currentApiType = ExamplesApiType.ESignature.ToString();

launcher-csharp/Properties/launchSettings.json

@@ -11,18 +11,18 @@
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": true,
+      "applicationUrl": "https://localhost:8080;http://localhost:5000",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
-      },
-      "applicationUrl": "https://localhost:8080;http://localhost:5000"
+      }
     },
     "CodeExamples": {
       "commandName": "Project",
       "launchBrowser": true,
+      "applicationUrl": "https://localhost:44333;http://localhost:5002",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
-      },
-      "applicationUrl": "https://localhost:44333;http://localhost:5002"
+      }
     }
   }
 }