Skip to content

Commit 143a48a

Browse files
garg-muditgarg-mudit
authored
Merge pull request #125 from docusign/WebForms_v1.1.0-1.0.5
WebForms - v1.1.0-1.0.5 Release
2 parents 3c7080d + f686b95 commit 143a48a

File tree

1 file changed

+158
-10
lines changed

1 file changed

+158
-10
lines changed

‎webforms.rest.swagger-v1.1.0.json‎

Lines changed: 158 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@
4848
"type": "string",
4949
"enum": [
5050
"owned_by_me",
51+
"created_by_me",
52+
"shared_with_me",
5153
"all"
5254
],
5355
"default": "all"
@@ -578,7 +580,6 @@
578580
"tokenUrl": "https://account-d.docusign.com/oauth/token",
579581
"scopes": {
580582
"webforms_read": "Read web form configuration",
581-
"webforms_write": "Create web form and modify web form configuration",
582583
"webforms_instance_read": "Read instance configuration",
583584
"webforms_instance_write": "Create instance and modify instance configuration"
584585
}
@@ -654,6 +655,13 @@
654655
"x-ds-definition-name": "LastModifiedDateTime",
655656
"x-ms-summary": "The DateTime when the webform instance is last modified."
656657
},
658+
"SubmittedDateTime": {
659+
"description": "",
660+
"type": "string",
661+
"format": "date-time",
662+
"x-ds-definition-name": "SubmittedDateTime",
663+
"x-ms-summary": ""
664+
},
657665
"IsStandalone": {
658666
"description": "Is the form a standalone form",
659667
"type": "boolean",
@@ -695,6 +703,19 @@
695703
"x-ds-definition-name": "InstanceStatus",
696704
"x-ms-summary": "The status of the form instance"
697705
},
706+
"InstanceRecipientStatus": {
707+
"type": "string",
708+
"description": "",
709+
"enum": [
710+
"INITIATED",
711+
"IN_PROGRESS",
712+
"SUBMITTED"
713+
],
714+
"example": "SUBMITTED",
715+
"maxLength": 15,
716+
"x-ds-definition-name": "InstanceRecipientStatus",
717+
"x-ms-summary": ""
718+
},
698719
"InstanceSource": {
699720
"type": "string",
700721
"description": "The method by which the form instance is created.\n",
@@ -710,6 +731,14 @@
710731
"x-ds-definition-name": "InstanceSource",
711732
"x-ms-summary": "The method by which the form instance is created.\n"
712733
},
734+
"RecipientViewId": {
735+
"type": "string",
736+
"description": "",
737+
"format": "uuid",
738+
"example": "00000000-0000-0000-0000-000000000000",
739+
"x-ds-definition-name": "RecipientViewId",
740+
"x-ms-summary": ""
741+
},
713742
"ClientUserId": {
714743
"type": "string",
715744
"description": "A unique identifier for a user that should originate from client's system. This value can be anything your backend system would use to track individual form instances. Examples include employee IDs, email addresses, surrogate key values, etc.",
@@ -727,7 +756,7 @@
727756
"AuthenticationMethod": {
728757
"type": "string",
729758
"description": "A value that most closely matches the technique your application used to authenticate the recipient / signer.",
730-
"example": "Biometric, Email, HTTPBasicAuth, Kerberos etc",
759+
"example": "Email",
731760
"maxLength": 40,
732761
"enum": [
733762
"Biometric",
@@ -772,6 +801,61 @@
772801
"x-ds-definition-name": "ReturnUrl",
773802
"x-ms-summary": "The url to which the user is redirected after the signing is completed"
774803
},
804+
"RoleName": {
805+
"description": "",
806+
"type": "string",
807+
"maxLength": 100,
808+
"example": "Applicant",
809+
"x-ds-definition-name": "RoleName",
810+
"x-ms-summary": ""
811+
},
812+
"Name": {
813+
"description": "",
814+
"type": "string",
815+
"maxLength": 100,
816+
"example": "Bob Smith",
817+
"x-ds-definition-name": "Name",
818+
"x-ms-summary": ""
819+
},
820+
"Email": {
821+
"description": "",
822+
"type": "string",
823+
"maxLength": 100,
824+
"example": "[email protected]",
825+
"x-ds-definition-name": "Email",
826+
"x-ms-summary": ""
827+
},
828+
"PhoneNumber": {
829+
"type": "object",
830+
"description": "",
831+
"properties": {
832+
"countryCode": {
833+
"type": "string",
834+
"maxLength": 7,
835+
"example": "1",
836+
"description": ""
837+
},
838+
"nationalNumber": {
839+
"type": "string",
840+
"maxLength": 15,
841+
"example": "4151112222",
842+
"description": ""
843+
}
844+
},
845+
"x-ds-definition-name": "PhoneNumber",
846+
"x-ms-summary": ""
847+
},
848+
"SendOption": {
849+
"type": "string",
850+
"description": "",
851+
"enum": [
852+
"now"
853+
],
854+
"example": "now",
855+
"maxLength": 15,
856+
"x-ds-definition-name": "SendOption",
857+
"x-ms-summary": ""
858+
},
775859
"ExpirationOffset": {
776860
"type": "integer",
777861
"minimum": 1,
@@ -828,9 +912,6 @@
828912
"CreateInstanceRequestBody": {
829913
"type": "object",
830914
"description": "The request body for the `Instances::createInstance` endpoint.",
831-
"required": [
832-
"clientUserId"
833-
],
834915
"properties": {
835916
"formValues": {
836917
"$ref": "#/definitions/WebFormValues",
@@ -864,6 +945,36 @@
864945
"$ref": "#/definitions/ExpirationOffset",
865946
"description": "The number of hours after which the web form instance expires. For example, if you want the instance to expire after 5 days, set this property to `120`.\n\nThis property is **optional.** The default value is `720` (30 days)."
866947
},
948+
"sendOption": {
949+
"$ref": "#/definitions/SendOption",
950+
"description": ""
951+
},
952+
"recipients": {
953+
"description": "",
954+
"type": "array",
955+
"items": {
956+
"type": "object",
957+
"required": [
958+
"roleName",
959+
"name",
960+
"email"
961+
],
962+
"properties": {
963+
"roleName": {
964+
"$ref": "#/definitions/RoleName"
965+
},
966+
"name": {
967+
"$ref": "#/definitions/Name"
968+
},
969+
"email": {
970+
"$ref": "#/definitions/Email"
971+
},
972+
"phoneNumber": {
973+
"$ref": "#/definitions/PhoneNumber"
974+
}
975+
}
976+
}
977+
},
867978
"tags": {
868979
"type": "array",
869980
"items": {
@@ -908,6 +1019,14 @@
9081019
"lastModifiedBy": {
9091020
"description": "The user who last modified the web form instance.",
9101021
"$ref": "#/definitions/WebFormUserInfo"
1022+
},
1023+
"submittedDateTime": {
1024+
"$ref": "#/definitions/SubmittedDateTime",
1025+
"description": ""
1026+
},
1027+
"instanceSource": {
1028+
"$ref": "#/definitions/InstanceSource",
1029+
"description": ""
9111030
}
9121031
},
9131032
"example": {
@@ -1000,6 +1119,11 @@
10001119
"properties": {
10011120
"id": {
10021121
"$ref": "#/definitions/EnvelopeId"
1122+
},
1123+
"createdDateTime": {
1124+
"description": "The dateTime when an envelope is created.",
1125+
"type": "string",
1126+
"format": "date-time"
10031127
}
10041128
}
10051129
}
@@ -1010,7 +1134,22 @@
10101134
},
10111135
"formValues": {
10121136
"$ref": "#/definitions/WebFormValues",
1013-
"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\nExample:\n```\n{\n \"Signer_name\": \"Francis Beagle\",\n \"Signer_email\": \"[email protected]\"\n}\n```"
1137+
"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"
1138+
},
1139+
"recipients": {
1140+
"description": "",
1141+
"type": "array",
1142+
"items": {
1143+
"type": "object",
1144+
"properties": {
1145+
"recipientViewId": {
1146+
"$ref": "#/definitions/RecipientViewId"
1147+
},
1148+
"instanceRecipientStatus": {
1149+
"$ref": "#/definitions/InstanceRecipientStatus"
1150+
}
1151+
}
1152+
}
10141153
}
10151154
},
10161155
"x-ds-definition-name": "WebFormInstance",
@@ -1143,7 +1282,10 @@
11431282
"Checkbox_hobbies": [
11441283
"singing",
11451284
"dancing"
1146-
]
1285+
],
1286+
"ID_card_attachment": {
1287+
"documentName": "id_card.pdf"
1288+
}
11471289
},
11481290
"x-ds-definition-name": "WebFormValues",
11491291
"x-ms-summary": "Key-value pairs of data used to create a form instance."
@@ -1178,6 +1320,11 @@
11781320
"isPrivateAccess": {
11791321
"$ref": "#/definitions/IsPrivateAccess",
11801322
"description": "When `true`, a valid instance token is required to access the instance via its URL. "
1323+
},
1324+
"allowSending": {
1325+
"type": "boolean",
1326+
"description": "",
1327+
"example": true
11811328
}
11821329
},
11831330
"x-ds-definition-name": "WebFormProperties",
@@ -1216,7 +1363,8 @@
12161363
"Number",
12171364
"RadioButtonGroup",
12181365
"Select",
1219-
"TextBox"
1366+
"TextBox",
1367+
"FileInput"
12201368
],
12211369
"example": "CheckboxGroup",
12221370
"x-ds-definition-name": "WebFormComponentType",
@@ -1447,7 +1595,7 @@
14471595
}
14481596
},
14491597
"example": {
1450-
"source": "template",
1598+
"source": "templates",
14511599
"owner": {
14521600
"userId": "00000000-0000-0000-0000-000000000000",
14531601
"userName": "DocuSign User"
@@ -1596,4 +1744,4 @@
15961744
"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."
15971745
}
15981746
]
1599-
}
1747+
}

0 commit comments

Comments
 (0)