Merge branch 'master' into feature/maestro-api-examples

Author: RomanBachaloSigmaSoftware

.gitignore

@@ -68,4 +68,7 @@ secret
 .vs
 
 # ignore RSA keys
-private.key
+private.key
+
+# ignore Web Form config
+web-form-config.json

README.md

@@ -52,6 +52,16 @@ For a list of code examples that use the Monitor API, see the [How-to guides ove
 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.
+
+
+## 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

@@ -15,7 +15,7 @@ pr:
 - releases/*
 
 pool:
-  name: Launcher Automation
+  name: launcher-automation-pool
 
 steps:
 - script: echo Hello, world!
@@ -54,7 +54,7 @@ steps:
   name: node_appsettings
   displayName: 'download appsettings.json'
   inputs:
-    secureFile: 'node_appsettings.json'
+    secureFile: 'node.appsettings.json'
 
 
 - script: |
@@ -97,4 +97,13 @@ steps:
 - script: |
     docker stop $(docker ps -a -q)
     docker rm $(docker ps -a -q)
-  displayName: 'stop node app'
+  displayName: 'stop node app'
+
+- script: |
+    allure generate --clean --output $(Build.SourcesDirectory)/node-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)/node-allure-output'

config/appsettings.example.json

@@ -29,6 +29,7 @@
   "clickAPIUrl": "https://demo.docusign.net/clickapi",
   "adminAPIUrl": "https://api-d.docusign.net/management",
   "monitorApiUrl": "https://lens-d.docusign.net",
-  "maestroApiUrl": "https://demo.services.docusign.net/",
+  "maestroApiUrl": "https://demo.services.docusign.net",
+  "webformsApiUrl": "https://apps-d.docusign.com/api/webforms/v1.1",
   "codeExamplesManifest": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/CodeExamplesManifest.json"
 }

demo_documents/World_Wide_Corp_Web_Form.pdf

@@ -55,6 +55,7 @@ const {
 
 const { eg001connect } = require('./lib/connect/controllers');
 const { eg001maestro, eg002maestro, eg003maestro } = require('./lib/maestro/controllers');
+const { eg001webforms } = require('./lib/webforms/controllers');
 
 const PORT = process.env.PORT || 3000;
 const HOST = process.env.HOST || 'localhost';
@@ -281,6 +282,12 @@ app.get('/mseg001', eg001maestro.getController)
   .get('/mseg003', eg003maestro.getController)
   .post('/mseg003', eg003maestro.createController);
 
+app.get('/weg001', eg001webforms.getController)
+  .get('/weg001webForm', eg001webforms.getWebFormCreateController)
+  .post('/weg001', eg001webforms.createWebFormTemplate)
+  .post('/weg001webForm', eg001webforms.createWebFormInstance);
+
+
 function dsLoginCB1(req, res, next) { req.dsAuthCodeGrant.oauth_callback1(req, res, next); }
 function dsLoginCB2(req, res, next) { req.dsAuthCodeGrant.oauth_callback2(req, res, next); }
 
@@ -326,8 +333,11 @@ const ADMIN_SCOPES = [
   'asset_group_account_clone_read'
 ];
 const MAESTRO_SCOPES = ['signature', 'aow_manage'];
+const WEBFORMS_SCOPES = [
+  'webforms_read', 'webforms_instance_read', 'webforms_instance_write'
+];
 
-const scope = [...ROOM_SCOPES, ...CLICK_SCOPES, ...MONITOR_SCOPES, ...ADMIN_SCOPES, ...SCOPES, ...MAESTRO_SCOPES];
+const scope = [...ROOM_SCOPES, ...CLICK_SCOPES, ...MONITOR_SCOPES, ...ADMIN_SCOPES, ...SCOPES, ...WEBFORMS_SCOPES, ...MAESTRO_SCOPES];
 
 // Configure passport for DocusignStrategy
 let docusignStrategy = new DocusignStrategy({

demo_documents/web-form-config.json

@@ -18,7 +18,7 @@ let DsJwtAuth = function _DsJwtAuth(req) {
     this.accountName = req.user && req.user.accountName;
     this.basePath = req.user && req.user.basePath;
     this._tokenExpiration = req.user && req.user.tokenExpirationTimestamp;
-    this.scopes = '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 click.manage click.send organization_read group_read permission_read user_read user_write account_read domain_read identity_provider_read user_data_redact asset_group_account_read asset_group_account_clone_write asset_group_account_clone_read webforms_manage aow_manage';
+    this.scopes = '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 click.manage click.send organization_read group_read permission_read user_read user_write account_read domain_read identity_provider_read user_data_redact asset_group_account_read asset_group_account_clone_write asset_group_account_clone_read webforms_read webforms_instance_read webforms_instance_write aow_manage';
 
     // For production use, you'd want to store the refresh token in non-volatile storage since it is
     // good for 30 days. You'd probably want to encrypt it too.

index.js

@@ -28,7 +28,11 @@ const auditUsers = async (args) => {
   let opts = {};
 
   for (const user of modifiedUsers) {
+  //ds-snippet-end:Admin5Step5
+  //ds-snippet-start:Admin5Step4  
     opts.email = user.email;
+    //ds-snippet-end:Admin5Step4
+    //ds-snippet-start:Admin5Step5
     const result = await usersApi.getUserProfiles(args.organizationId, opts);
     results.push(result.users);
   }

lib/DSJwtAuth.js

@@ -18,7 +18,7 @@
      this.accountName = req.user && req.user.accountName;
      this.basePath = req.user && req.user.basePath;
      this._tokenExpiration = req.user && req.user.tokenExpirationTimestamp;
-     this.scopes = '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 click.manage click.send aow_manage';
+     this.scopes = '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 click.manage click.send webforms_read webforms_instance_read webforms_instance_write aow_manage';
 
      // For production use, you'd want to store the refresh token in non-volatile storage since it is
      // good for 30 days. You'd probably want to encrypt it too.