Skip to content

FLOW-278: Get Envelope Custom Fields Step #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 13, 2022
Merged

FLOW-278: Get Envelope Custom Fields Step #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84688bf
FLOW-278: Get Envelope Custom Fields Step
sriharip-docusign Dec 13, 2022
656dd62
Expose field id and name in the get envelope custom field step
sriharip-docusign Dec 13, 2022
212ac10
Merge branch 'microsoft:dev' into get_ecf
sriharip-docusign Dec 13, 2022
4057095
Merge branch 'dev' into get_ecf
sriharip-docusign Dec 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 138 additions & 0 deletions certified-connectors/DocuSignDemo/apiDefinition.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,6 +637,86 @@
"x-ms-visibility": "important"
}
},
"/accounts/{accountId}/envelopes/{envelopeId}/custom_fields": {
"get": {
"tags": [
"DocuSign"
],
"summary": "Get envelope custom fields",
"description": "Get envelope custom fields.",
"operationId": "GetEnvelopeCustomFields",
"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": "fieldName",
"in": "query",
"description": "Custom Field Name",
"required": true,
"x-ms-summary": "Custom Field Name",
"x-ms-visibility": "important",
"x-ms-dynamic-values": {
"operationId": "GetAccountCustomFields",
"parameters": {
"accountId": {
"parameter": "accountId"
}
},
"value-collection": "customFields",
"value-path": "name",
"value-title": "name"
},
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EnvelopeCustomFieldResponse"
}
}
},
"deprecated": false,
"x-ms-no-generic-test": true,
"x-ms-visibility": "important"
}
},
"/accounts/{accountId}/envelopes/{envelopeId}/views/sender": {
"post": {
"tags":[
Expand Down Expand Up @@ -1569,6 +1649,47 @@
"x-ms-visibility": "internal"
}
},
"/accounts/{accountId}/account_custom_fields": {
"get": {
"tags": [
"DocuSign"
],
"summary": "Get account custom fields",
"description": "Get the custom fields for a specified account.",
"operationId": "GetAccountCustomFields",
"consumes": [],
"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"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"deprecated": false,
"x-ms-visibility": "important"
}
},
"/accounts/{accountId}/folders": {
"get": {
"tags": [
Expand Down Expand Up @@ -3256,6 +3377,23 @@
}
}
},
"EnvelopeCustomFieldResponse": {
"type": "object",
"properties": {
"fieldId": {
"description": "The id of the envelope custom field.",
"type": "string",
"x-ms-summary": "Field ID",
"x-ms-visibility": "important"
},
"name": {
"description": "The name of the envelope custom field.",
"type": "string",
"x-ms-summary": "Name",
"x-ms-visibility": "important"
}
}
},
"Folder": {
"type": "object",
"properties": {
Expand Down
62 changes: 61 additions & 1 deletion certified-connectors/DocuSignDemo/script.csx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1451,6 +1451,13 @@ public class Script : ScriptBase
this.Context.Request.RequestUri = uriBuilder.Uri;
}

if ("GetAccountCustomFields".Equals(this.Context.OperationId, StringComparison.OrdinalIgnoreCase))
{
var uriBuilder = new UriBuilder(this.Context.Request.RequestUri);
uriBuilder.Path = uriBuilder.Path.Replace("/account_custom_fields", "/custom_fields");
this.Context.Request.RequestUri = uriBuilder.Uri;
}

if ("GetLoginAccounts".Equals(this.Context.OperationId, StringComparison.OrdinalIgnoreCase))
{
var uriBuilder = new UriBuilder(this.Context.Request.RequestUri);
Expand Down Expand Up @@ -1649,7 +1656,60 @@ public class Script : ScriptBase

response.Content = new StringContent(newBody.ToString(), Encoding.UTF8, "application/json");
}


if ("GetAccountCustomFields".Equals(this.Context.OperationId, StringComparison.OrdinalIgnoreCase))
{
var body = ParseContentAsJObject(await response.Content.ReadAsStringAsync().ConfigureAwait(false), false);
var customFields = new JArray();

foreach (var customField in (body["textCustomFields"] as JArray) ?? new JArray())
{
customFields.Add(customField);
}

foreach (var customField in (body["listCustomFields"] as JArray) ?? new JArray())
{
customFields.Add(customField);
}

var newBody = new JObject
{
["customFields"] = customFields
};

response.Content = new StringContent(newBody.ToString(), Encoding.UTF8, "application/json");
}

if ("GetEnvelopeCustomFields".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);
var customFieldName = query.Get("fieldName");
var responseCustomField = new JObject();

foreach (var customField in (body["textCustomFields"] as JArray) ?? new JArray())
{
if (customField["name"].ToString().Equals(customFieldName))
{
customField["type"] = "text";
responseCustomField = customField as JObject;
break;
}
}

foreach (var customField in (body["listCustomFields"] as JArray) ?? new JArray())
{
if (customField["name"].ToString().Equals(customFieldName))
{
customField["type"] = "list";
responseCustomField = customField as JObject;
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);
Expand Down