Merge branch 'master' into feature/add-and-configure-linter

Author: annahileta

.github/workflows/node.js.yml

@@ -0,0 +1,46 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+        
+    - name: Run clean install
+      run: |
+        npm cache clean --force
+        npm cache verify
+        npm install
+      
+    - name: Run build
+      run: npm run build --if-present
+    
+    - name: Run tests
+      run: npm test
+      env:  
+        CLIENT_ID: ${{ secrets.CLIENT_ID }}
+        USER_ID: ${{ secrets.USER_ID }}
+        APP_URL: ${{ secrets.APP_URL }}
+        SIGNER_EMAIL: ${{ secrets.SIGNER_EMAIL }}
+        SIGNER_NAME: ${{ secrets.SIGNER_NAME }}
+        PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}

README.md

@@ -17,36 +17,41 @@ When the token expires, it updates automatically.
 
 ## 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 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, select the Node.js tab under [Examples and languages](https://developers.docusign.com/docs/esign-rest-api/how-to/code-launchers#examples-and-languages) on the DocuSign Developer Center.
+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.
 
-## Rooms API
 
-**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/).
+## Rooms API 
 
-For a list of code examples that use the Rooms API, select the Node.js tab under [Examples and languages](https://developers.docusign.com/docs/rooms-api/how-to/code-launchers#examples-and-languages) on the DocuSign Developer Center.
+**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/).  
 
-## Click API
+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.
 
-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).
 
-For a list of code examples that use the Click API, select the Node.js tab under [Examples and languages](https://developers.docusign.com/docs/click-api/how-to/code-launchers#examples-and-languages) on the DocuSign Developer Center.
+## 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)  
+
+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.
+
 
 ## Monitor API
-**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/).
-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/).
 
-For a list of code examples that use the Monitor API, select the Node.js tab under [Examples and languages](https://developers.docusign.com/docs/monitor-api/how-to/code-launchers/#examples-and-languages) on the DocuSign Developer Center.
+**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/).  
+
+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/). 
+
+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.
+
 
 ## Admin API
-**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).
 
-For more 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/).
+**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).
 
-For a list of code examples that use the Admin API, select the Node.js tab under [Examples and languages](https://developers.docusign.com/docs/admin-api/how-to/code-launchers/#examples-and-languages) on the DocuSign Developer Center.
+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

azure-pipelines.yml

@@ -0,0 +1,30 @@
+# 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
+
+trigger:
+- master
+
+# pool:
+#   vmImage: ubuntu-latest
+
+pool:
+  name: defualt
+
+steps:
+- script: echo Hello, world!
+  displayName: 'Run a one-line script'
+
+# - script: |
+#     echo Add other tasks to build, test, and deploy your project.
+#     echo See https://aka.ms/yaml
+#   displayName: 'Run a multi-line script'
+
+- script: |
+  allure –-version
+  java --version
+  javac --version
+  mvn --version
+  docker --version
+

config/appsettings.example.json

@@ -29,9 +29,5 @@
   "clickAPIUrl": "https://demo.docusign.net/clickapi",
   "adminAPIUrl": "https://api-d.docusign.net/management",
   "monitorApiUrl": "https://lens-d.docusign.net",
-  "eSignManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/eSignatureManifest.json",
-  "clickManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/ClickManifest.json",
-  "roomsManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/RoomsManifest.json",
-  "adminManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/AdminManifest.json",
-  "monitorManifestUrl": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/MonitorManifest.json"
+  "codeExamplesManifest": "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/CodeExamplesManifest.json"
 }

demo_documents/Offer_Letter_Demo.docx

@@ -18,6 +18,7 @@ const sendEnvelopeForEmbeddedSigning = async (args) => {
   // args.accessToken
   // args.accountId
 
+  //ds-snippet-start:eSign1Step3
   let dsApiClient = new docusign.ApiClient();
   dsApiClient.setBasePath(args.basePath);
   dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken);
@@ -32,11 +33,13 @@ const sendEnvelopeForEmbeddedSigning = async (args) => {
   results = await envelopesApi.createEnvelope(args.accountId, {
     envelopeDefinition: envelope,
   });
+  //ds-snippet-end:eSign1Step3
 
   let envelopeId = results.envelopeId;
   console.log(`Envelope was created. EnvelopeId ${envelopeId}`);
 
   // Step 3. create the recipient view, the embedded signing
+  //ds-snippet-start:eSign1Step5
   let viewRequest = makeRecipientViewRequest(args.envelopeArgs);
   // Call the CreateRecipientView API
   // Exceptions will be caught by the calling function
@@ -46,6 +49,7 @@ const sendEnvelopeForEmbeddedSigning = async (args) => {
 
   return { envelopeId: envelopeId, redirectUrl: results.url };
 };
+//ds-snippet-end:eSign1Step5
 
 /**
  * Creates envelope
@@ -54,6 +58,8 @@ const sendEnvelopeForEmbeddedSigning = async (args) => {
  * @returns {Envelope} An envelope definition
  * @private
  */
+
+//ds-snippet-start:eSign1Step2
 function makeEnvelope(args) {
   // Data for this method
   // args.signerEmail
@@ -125,7 +131,9 @@ function makeEnvelope(args) {
 
   return env;
 }
+//ds-snippet-end:eSign1Step2
 
+//ds-snippet-start:eSign1Step4
 function makeRecipientViewRequest(args) {
   // Data for this method
   // args.dsReturnUrl
@@ -168,5 +176,6 @@ function makeRecipientViewRequest(args) {
 
   return viewRequest;
 }
+//ds-snippet-end:eSign1Step4
 
-module.exports = { sendEnvelopeForEmbeddedSigning };
+module.exports = { sendEnvelopeForEmbeddedSigning, makeEnvelope, makeRecipientViewRequest };