Merge pull request #14 from sriharip-docusign/ecf_update

FLOW-276: Update Envelope Custom Fields Step

Author: sriharip-docusign

certified-connectors/DocuSignDemo/apiDefinition.swagger.json

@@ -642,9 +642,9 @@
         "tags": [
           "DocuSign"
         ],
-        "summary": "Get envelope custom fields",
-        "description": "Get envelope custom fields.",
-        "operationId": "GetEnvelopeCustomFields",
+        "summary": "Get envelope custom field",
+        "description": "Get details for the specified envelope custom field.",
+        "operationId": "GetEnvelopeCustomField",
         "consumes": [
           "application/json",
           "text/json",
@@ -715,6 +715,98 @@
         "deprecated": false,
         "x-ms-no-generic-test": true,
         "x-ms-visibility": "important"
+      },
+      "put": {
+        "tags":[
+          "DocuSign"
+        ],
+        "summary": "Update envelope custom field",
+        "description": "Update value for the specified envelope custom field",
+        "operationId": "UpdateEnvelopeCustomField",
+        "consumes":[
+          "application/json",
+          "text/json",
+          "application/xml",
+          "text/xml",
+          "application/x-www-form-urlencoded"
+        ],
+        "produces":[
+          "application/json",
+          "text/json",
+          "application/xml",
+          "text/xml"
+        ],
+        "parameters":[
+          {
+            "name": "accountId",
+            "in": "path",
+            "description": "Account id",
+            "required": true,
+            "x-ms-summary": "Account",
+            "x-ms-test-value": "insert account id",
+            "x-ms-dynamic-values": {
+              "operationId": "GetLoginAccounts",
+              "value-collection": "loginAccounts",
+              "value-path": "accountIdGuid",
+              "value-title": "name"
+            },
+            "type": "string"
+          },
+          {
+            "name": "envelopeId",
+            "in": "path",
+            "description": "Envelope id",
+            "required": true,
+            "x-ms-summary": "Envelope",
+            "x-ms-test-value": "insert envelope id",
+            "type": "string"
+          },
+          {
+            "name": "fieldId",
+            "in": "query",
+            "description": "Custom Field ID",
+            "required": true,
+            "x-ms-summary": "Field ID",
+            "type": "string"
+          },
+          {
+            "name": "fieldType",
+            "in":"query",
+            "description": "Custom Field Type",
+            "required":true,
+            "x-ms-summary": "Field Type",
+            "type":"string",
+            "enum":["Text", "List"],
+            "default": "Text"
+          },
+          {
+            "name": "name",
+            "in": "query",
+            "description": "Custom Field Name",
+            "required": true,
+            "x-ms-summary": "Name",
+            "type": "string"
+          },          
+          {
+            "name": "value",
+            "in": "query",
+            "description": "Custom Field Value",
+            "required": true,
+            "x-ms-summary": "Value",
+            "type": "string"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/UpdateEnvelopeCustomFieldResponse"
+            }
+          }
+        },
+        "deprecated":false,
+        "x-ms-visibility": "important",
+        "x-ms-no-generic-test": true
       }
     },    
     "/accounts/{accountId}/envelopes/{envelopeId}/views/sender": {
@@ -1687,7 +1779,7 @@
           }
         },
         "deprecated": false,
-        "x-ms-visibility": "important"
+        "x-ms-visibility": "internal"
       }
     },    
     "/accounts/{accountId}/folders": {
@@ -3386,14 +3478,49 @@
           "x-ms-summary": "Field ID",
           "x-ms-visibility": "important"
         },
+        "fieldType": {
+          "description": "The type of the envelope custom field.",
+          "type": "string",
+          "x-ms-summary": "Field Type",
+          "x-ms-visibility": "important"
+        },
         "name": {
           "description": "The name of the envelope custom field.",
           "type": "string",
           "x-ms-summary": "Name",
           "x-ms-visibility": "important"
-        }
+        }        
       }
-    },    
+    },
+    "UpdateEnvelopeCustomFieldResponse": {
+      "type": "object",
+      "properties": {
+        "fieldId": {
+          "description": "The id of the envelope custom field.",
+          "type": "string",
+          "x-ms-summary": "Field ID",
+          "x-ms-visibility": "important"
+        },
+        "fieldType": {
+          "description": "The type of the envelope custom field.",
+          "type": "string",
+          "x-ms-summary": "Field Type",
+          "x-ms-visibility": "important"
+        },
+        "name": {
+          "description": "The name of the envelope custom field.",
+          "type": "string",
+          "x-ms-summary": "Name",
+          "x-ms-visibility": "important"
+        },
+        "value": {
+          "description": "The value of the envelope custom field.",
+          "type": "string",
+          "x-ms-summary": "Value",
+          "x-ms-visibility": "important"
+        }           
+      }
+    },
     "Folder": {
       "type": "object",
       "properties": {

certified-connectors/DocuSignDemo/script.csx

@@ -887,6 +887,37 @@ public class Script : ScriptBase
 
     return newBody;
   }
+
+  private JObject UpdateEnvelopeCustomFieldBodyTransformation(JObject body)
+  {
+    var query = HttpUtility.ParseQueryString(this.Context.Request.RequestUri.Query);
+    var textCustomFields = new JArray();
+    var listCustomFields = new JArray();
+    var fieldType = query.Get("fieldType");
+    var customField = new JObject() {
+      ["fieldId"] = query.Get("fieldId"),
+	    ["name"] = query.Get("name"),
+	    ["value"] = query.Get("value")
+    };
+
+    if (fieldType.Equals("Text"))
+    {
+      textCustomFields.Add(customField);
+    }
+
+    if (fieldType.Equals("List"))
+    {
+      listCustomFields.Add(customField);
+    }
+
+    var newBody = new JObject()
+    {
+      ["textCustomFields"] = textCustomFields,
+      ["listCustomFields"] = listCustomFields
+    };
+
+    return newBody;
+  }
 
   private void ParseCustomFields(JObject body, JArray textCustomFields,  JArray listCustomFields)
   {
@@ -1387,6 +1418,11 @@ public class Script : ScriptBase
       await this.TransformRequestJsonBody(this.AddVerificationToRecipientBodyTransformation).ConfigureAwait(false);
     }
 
+    if ("UpdateEnvelopeCustomField".Equals(this.Context.OperationId, StringComparison.OrdinalIgnoreCase))
+    {
+      await this.TransformRequestJsonBody(this.UpdateEnvelopeCustomFieldBodyTransformation).ConfigureAwait(false);
+    }
+
     if ("GenerateEmbeddedSigningURL".Equals(this.Context.OperationId, StringComparison.OrdinalIgnoreCase))
     {
       await this.TransformRequestJsonBody(this.GenerateEmbeddedSigningURLBodyTransformation).ConfigureAwait(false);
@@ -1678,9 +1714,9 @@ public class Script : ScriptBase
       };
 
       response.Content = new StringContent(newBody.ToString(), Encoding.UTF8, "application/json");
-    }    
+    }
 
-    if ("GetEnvelopeCustomFields".Equals(this.Context.OperationId, StringComparison.OrdinalIgnoreCase))
+    if ("GetEnvelopeCustomField".Equals(this.Context.OperationId, StringComparison.OrdinalIgnoreCase))
     {
       var body = ParseContentAsJObject(await response.Content.ReadAsStringAsync().ConfigureAwait(false), false);
       var query = HttpUtility.ParseQueryString(this.Context.Request.RequestUri.Query);
@@ -1691,7 +1727,7 @@ public class Script : ScriptBase
       {
         if (customField["name"].ToString().Equals(customFieldName))
         {
-          customField["type"] = "text";
+          customField["fieldType"] = "Text";
           responseCustomField = customField as JObject;
           break;
         }
@@ -1701,7 +1737,7 @@ public class Script : ScriptBase
       {
         if (customField["name"].ToString().Equals(customFieldName))
         {
-          customField["type"] = "list";
+          customField["fieldType"] = "List";
           responseCustomField = customField as JObject;
           break;
         }
@@ -1710,6 +1746,28 @@ public class Script : ScriptBase
       response.Content = new StringContent(responseCustomField.ToString(), Encoding.UTF8, "application/json");
     }
 
+    if ("UpdateEnvelopeCustomField".Equals(this.Context.OperationId, StringComparison.OrdinalIgnoreCase))
+    {
+      var body = ParseContentAsJObject(await response.Content.ReadAsStringAsync().ConfigureAwait(false), false);
+      var responseCustomField = new JObject();
+
+      foreach (var customField in (body["textCustomFields"] as JArray) ?? new JArray())
+      {
+        responseCustomField = customField as JObject;
+        responseCustomField["fieldType"] = "Text";
+        break;
+      }
+      
+      foreach (var customField in (body["listCustomFields"] as JArray) ?? new JArray())
+      {
+        responseCustomField = customField as JObject;
+        responseCustomField["fieldType"] = "List";
+        break;
+      }
+      
+      response.Content = new StringContent(responseCustomField.ToString(), Encoding.UTF8, "application/json");
+    }
+
     if ("AddRecipientToEnvelopeV2".Equals(this.Context.OperationId, StringComparison.OrdinalIgnoreCase))
     {
       var body = ParseContentAsJObject(await response.Content.ReadAsStringAsync().ConfigureAwait(false), false);