Skip to content

WebForms - v1.1.0-1.0.6 Release #134

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

Open
balaji1103 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

WebForms - v1.1.0-1.0.6 Release #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 49 additions & 27 deletions webforms.rest.swagger-v1.1.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,6 +580,7 @@
"tokenUrl": "https://account-d.docusign.com/oauth/token",
"scopes": {
"webforms_read": "Read web form configuration",
"webforms_write": "Create web form and modify web form configuration",
"webforms_instance_read": "Read instance configuration",
"webforms_instance_write": "Create instance and modify instance configuration"
}
Expand Down Expand Up @@ -914,8 +915,24 @@
"description": "The request body for the `Instances::createInstance` endpoint.",
"properties": {
"formValues": {
"$ref": "#/definitions/WebFormValues",
"description": "Key-value pairs used to prefill fields in the web form instance. The keys correspond to the values of the `publishedComponentNames` object on the `WebForm` (configuration) object.\n\nFor keys of type TextBox, Email, Date, Select, and RadioButtonGroup, the value should be a string. For keys of type Number, the value should be a number. For keys of type of CheckboxGroup, the value should be an array of strings.\n\nFor example, a web form configuration might have the following properties indicated by the `publishedComponentNames` object:\n```\n\"publishedComponentNames\": {\n \"Signer_name\": \"TextBox\",\n \"Signer_email\": \"Email\",\n \"Dropdown\": \"Select\",\n \"Hobbies\": \"CheckboxGroup\"\n}\n```\n\nThen, this property might be:\n```\n{\n \"Signer_name\": \"Francis Beagle\",\n \"Signer_email\": \"francis@example.com\",\n \"Hobbies\": [\"walking\", \"napping\"]\n}\n```\n\nNote that you do not have to include values for every component. This property is **optional.**"
"type": "object",
"description": "Key-value pairs used to prefill fields in the web form instance. The keys correspond to the values of the `publishedComponentNames` object on the `WebForm` (configuration) object.\n\nFor keys of type TextBox, Email, Date, Select, and RadioButtonGroup, the value should be a string. For keys of type Number, the value should be a number. For keys of type of CheckboxGroup, the value should be an array of strings.\n\nFor example, a web form configuration might have the following properties indicated by the `publishedComponentNames` object:\n```\n\"publishedComponentNames\": {\n \"Signer_name\": \"TextBox\",\n \"Signer_email\": \"Email\",\n \"Dropdown\": \"Select\",\n \"Hobbies\": \"CheckboxGroup\"\n}\n```\n\nThen, this property might be:\n```\n{\n \"Signer_name\": \"Francis Beagle\",\n \"Signer_email\": \"francis@example.com\",\n \"Hobbies\": [\"walking\", \"napping\"]\n}\n```\n\nNote that you do not have to include values for every component. This property is **optional.**",
"additionalProperties": {},
"example": {
"Textbox_Name": "First Last",
"Email_primary": "example@example.com",
"Date_birth": "2020-01-01",
"Number_age": 52,
"Select_state": "California",
"Radio_Gender": "Female",
"Checkbox_hobbies": [
"singing",
"dancing"
],
"ID_card_attachment": {
"documentName": "id_card.pdf"
}
}
},
"clientUserId": {
"$ref": "#/definitions/ClientUserId",
Expand Down Expand Up @@ -949,6 +966,10 @@
"$ref": "#/definitions/SendOption",
"description": ""
},
"brandId": {
"$ref": "#/definitions/BrandId",
"description": ""
},
"recipients": {
"description": "",
"type": "array",
Expand Down Expand Up @@ -1133,8 +1154,28 @@
"description": "Metadata associated with the web form instance."
},
"formValues": {
"$ref": "#/definitions/WebFormValues",
"description": "Key-value pairs that represent the current values of the fields in the web form instance. The keys correspond to the `componentName` values of the `formContent.components` object on the `WebForm` (configuration) object. See [Form field definitions](/docs/web-forms-api/plan-integration/retrieve-configuration-details/#form-field-definitions) for more information.\n\nSee [Request that retrieves web form instance values](/docs/web-forms-api/plan-integration/retrieve-submitted-values/#request-that-retrieves-web-form-instance-values) for an example of a `formValues` object returned by this request.\n"
"type": "object",
"description": "Key-value pairs that represent the current values of the fields in the web form instance. The keys correspond to the `componentName` values of the `formContent.components` object on the `WebForm` (configuration) object. See [Form field definitions](/docs/web-forms-api/plan-integration/retrieve-configuration-details/#form-field-definitions) for more information.\n\nSee [Request that retrieves web form instance values](/docs/web-forms-api/plan-integration/retrieve-submitted-values/#request-that-retrieves-web-form-instance-values) for an example of a `formValues` object returned by this request.\n",
"additionalProperties": {},
"example": {
"Textbox_Name": "First Last",
"Email_primary": "example@example.com",
"Date_birth": "2020-01-01",
"Number_age": 52,
"Select_state": "California",
"Radio_Gender": "Female",
"Checkbox_hobbies": [
"singing",
"dancing"
],
"ID_card_attachment": {
"documentName": "id_card.pdf"
}
}
},
"brandId": {
"$ref": "#/definitions/BrandId",
"description": ""
},
"recipients": {
"description": "",
Expand All @@ -1147,6 +1188,9 @@
},
"instanceRecipientStatus": {
"$ref": "#/definitions/InstanceRecipientStatus"
},
"roleName": {
"$ref": "#/definitions/RoleName"
}
}
}
Expand Down Expand Up @@ -1268,28 +1312,6 @@
"x-ds-definition-name": "WebForm",
"x-ms-summary": "A web form configuration."
},
"WebFormValues": {
"type": "object",
"description": "Key-value pairs of data used to create a form instance.",
"additionalProperties": {},
"example": {
"Textbox_Name": "First Last",
"Email_primary": "example@example.com",
"Date_birth": "2020-01-01",
"Number_age": 52,
"Select_state": "California",
"Radio_Gender": "Female",
"Checkbox_hobbies": [
"singing",
"dancing"
],
"ID_card_attachment": {
"documentName": "id_card.pdf"
}
},
"x-ds-definition-name": "WebFormValues",
"x-ms-summary": "Key-value pairs of data used to create a form instance."
},
"WebFormState": {
"type": "string",
"description": "The state of the form content",
Expand Down Expand Up @@ -1744,4 +1766,4 @@
"description": "<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact \n[DocuSign Support](https://support.docusign.com/s/?language=en_US) or your account manager to find out whether the Web Forms API is available for your production account plan.</ds-inlinemessage>\n\nMethods for working with web forms."
}
]
}
}