boldsign 3.1.4 → 3.2.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1424) hide show
  1. package/.openapi-generator/FILES +222 -184
  2. package/.openapi-generator/VERSION +1 -1
  3. package/.openapi-generator-ignore +23 -23
  4. package/LICENSE +21 -21
  5. package/README.md +386 -345
  6. package/WebhookUtility.ts +145 -0
  7. package/api/apis.ts +208 -208
  8. package/api/brandingApi.ts +1233 -1233
  9. package/api/contactsApi.ts +772 -772
  10. package/api/customFieldApi.ts +817 -817
  11. package/api/documentApi.ts +3599 -3470
  12. package/api/groupContactsApi.ts +779 -779
  13. package/api/identityVerificationApi.ts +586 -586
  14. package/api/index.ts +38 -38
  15. package/api/planApi.ts +274 -274
  16. package/api/senderIdentitiesApi.ts +1017 -1017
  17. package/api/teamsApi.ts +661 -661
  18. package/api/templateApi.ts +2317 -2046
  19. package/api/userApi.ts +1094 -1094
  20. package/api.ts +3 -3
  21. package/auth/OAuthClient.ts +137 -0
  22. package/auth/OAuthToken.ts +17 -0
  23. package/auth/PKCEHelper.ts +36 -0
  24. package/docs/AccessCodeDetail.md +20 -19
  25. package/docs/AccessCodeDetails.md +13 -13
  26. package/docs/Added.md +13 -13
  27. package/docs/Address.md +16 -16
  28. package/docs/AttachmentInfo.md +14 -14
  29. package/docs/AuditTrail.md +25 -25
  30. package/docs/AuthenticationSettings.md +11 -11
  31. package/docs/Base64File.md +12 -12
  32. package/docs/BehalfDocument.md +29 -29
  33. package/docs/BehalfDocumentRecords.md +12 -12
  34. package/docs/BehalfOf.md +12 -12
  35. package/docs/BehalfOfWebhookModel.md +12 -0
  36. package/docs/BillingViewModel.md +11 -11
  37. package/docs/BrandCreated.md +11 -11
  38. package/docs/BrandCustomFieldDetails.md +16 -16
  39. package/docs/BrandingApi.md +268 -268
  40. package/docs/BrandingMessage.md +11 -11
  41. package/docs/BrandingRecords.md +11 -11
  42. package/docs/ChangeRecipient.md +18 -18
  43. package/docs/ChangeTeamRequest.md +12 -12
  44. package/docs/CheckboxValidationSettings.md +13 -0
  45. package/docs/CollaborationSettings.md +14 -14
  46. package/docs/ConditionalRule.md +13 -13
  47. package/docs/ContactCreated.md +12 -12
  48. package/docs/ContactDetails.md +15 -15
  49. package/docs/ContactPageDetails.md +13 -13
  50. package/docs/ContactsApi.md +176 -176
  51. package/docs/ContactsDetails.md +16 -16
  52. package/docs/ContactsList.md +12 -12
  53. package/docs/CreateContactResponse.md +11 -11
  54. package/docs/CreateGroupContactResponse.md +12 -12
  55. package/docs/CreateSenderIdentityRequest.md +17 -17
  56. package/docs/CreateTeamRequest.md +11 -11
  57. package/docs/CreateTemplateRequest.md +40 -39
  58. package/docs/CreateUser.md +14 -14
  59. package/docs/Creators.md +12 -12
  60. package/docs/CustomDomainSettings.md +12 -12
  61. package/docs/CustomFieldApi.md +174 -174
  62. package/docs/CustomFieldCollection.md +11 -11
  63. package/docs/CustomFieldMessage.md +12 -12
  64. package/docs/CustomFormField.md +46 -44
  65. package/docs/Date.md +13 -13
  66. package/docs/DeleteCustomFieldReply.md +11 -11
  67. package/docs/Document.md +28 -28
  68. package/docs/DocumentApi.md +925 -891
  69. package/docs/DocumentCC.md +11 -11
  70. package/docs/DocumentCcDetails.md +12 -12
  71. package/docs/DocumentCcWebhookModel.md +12 -0
  72. package/docs/DocumentCreated.md +11 -11
  73. package/docs/DocumentEdited.md +11 -11
  74. package/docs/DocumentEvent.md +37 -0
  75. package/docs/DocumentExpirySettings.md +16 -16
  76. package/docs/DocumentFiles.md +16 -16
  77. package/docs/DocumentFormFields.md +53 -53
  78. package/docs/DocumentGroupSignerWebhookModel.md +18 -0
  79. package/docs/DocumentInfo.md +14 -14
  80. package/docs/DocumentProperties.md +58 -54
  81. package/docs/DocumentReassign.md +13 -13
  82. package/docs/DocumentRecords.md +12 -12
  83. package/docs/DocumentSender.md +14 -0
  84. package/docs/DocumentSenderDetail.md +14 -14
  85. package/docs/DocumentSigner.md +35 -34
  86. package/docs/DocumentSignerDetails.md +42 -41
  87. package/docs/DocumentSignerWebhookModel.md +37 -0
  88. package/docs/DocumentTags.md +12 -12
  89. package/docs/DownloadImageRequest.md +16 -16
  90. package/docs/EditDocumentFile.md +14 -14
  91. package/docs/EditDocumentRequest.md +42 -41
  92. package/docs/EditDocumentSigner.md +36 -35
  93. package/docs/EditFormField.md +52 -52
  94. package/docs/EditSenderIdentityRequest.md +15 -15
  95. package/docs/EditTemplateRequest.md +35 -34
  96. package/docs/EditableDateFieldSettings.md +14 -14
  97. package/docs/EmbeddedCloneDocumentJsonRequest.md +22 -0
  98. package/docs/EmbeddedCloneTemplateJsonRequest.md +22 -0
  99. package/docs/EmbeddedClonedDocument.md +12 -0
  100. package/docs/EmbeddedClonedTemplate.md +12 -0
  101. package/docs/EmbeddedCreateTemplateRequest.md +51 -50
  102. package/docs/EmbeddedCustomFieldCreated.md +11 -11
  103. package/docs/EmbeddedDocumentEditJsonRequest.md +19 -19
  104. package/docs/EmbeddedDocumentEdited.md +11 -11
  105. package/docs/EmbeddedDocumentRequest.md +59 -58
  106. package/docs/EmbeddedFileDetails.md +16 -16
  107. package/docs/EmbeddedFileLink.md +11 -11
  108. package/docs/EmbeddedMergeTemplateFormRequest.md +60 -59
  109. package/docs/EmbeddedSendCreated.md +12 -12
  110. package/docs/EmbeddedSendTemplateFormRequest.md +57 -56
  111. package/docs/EmbeddedSigningLink.md +11 -11
  112. package/docs/EmbeddedTemplateCreated.md +12 -12
  113. package/docs/EmbeddedTemplateEditRequest.md +21 -21
  114. package/docs/EmbeddedTemplateEdited.md +11 -11
  115. package/docs/EmbeddedTemplatePreview.md +11 -11
  116. package/docs/EmbeddedTemplatePreviewJsonRequest.md +12 -12
  117. package/docs/Error.md +12 -12
  118. package/docs/ErrorResponse.md +12 -0
  119. package/docs/ErrorResult.md +11 -11
  120. package/docs/ExistingFormField.md +15 -15
  121. package/docs/ExtendExpiry.md +14 -14
  122. package/docs/FileInfo.md +14 -14
  123. package/docs/Font.md +18 -18
  124. package/docs/FormField.md +53 -53
  125. package/docs/FormFieldPermission.md +13 -13
  126. package/docs/FormFieldPermissionWebhookModel.md +13 -0
  127. package/docs/FormGroup.md +15 -15
  128. package/docs/FormulaFieldSettings.md +12 -12
  129. package/docs/GetGroupContactDetails.md +15 -15
  130. package/docs/GroupContact.md +14 -14
  131. package/docs/GroupContactDetails.md +13 -13
  132. package/docs/GroupContactsApi.md +177 -177
  133. package/docs/GroupContactsList.md +12 -12
  134. package/docs/GroupOption.md +12 -0
  135. package/docs/GroupSigner.md +17 -17
  136. package/docs/GroupSignerSettings.md +12 -12
  137. package/docs/GroupSignerSettingsWebhookModel.md +12 -0
  138. package/docs/GroupUser.md +12 -12
  139. package/docs/IWebhookData.md +56 -0
  140. package/docs/IdDocument.md +21 -21
  141. package/docs/IdReport.md +14 -14
  142. package/docs/IdVerificationDetails.md +20 -20
  143. package/docs/{IdVerification.md → IdVerificationSignerWebhookModel.md} +19 -19
  144. package/docs/IdentityVerificationApi.md +109 -109
  145. package/docs/IdentityVerificationEvent.md +17 -0
  146. package/docs/IdentityVerificationSettings.md +17 -17
  147. package/docs/ImageInfo.md +13 -13
  148. package/docs/KbaAuthenticationEvent.md +17 -0
  149. package/docs/{ProblemDetails.md → KbaDetails.md} +14 -15
  150. package/docs/KbaSettings.md +13 -0
  151. package/docs/KbaSignerWebhookModel.md +14 -0
  152. package/docs/MergeAndSendForSignForm.md +50 -49
  153. package/docs/ModificationDetails.md +12 -12
  154. package/docs/NotificationSettings.md +22 -22
  155. package/docs/PageDetails.md +16 -16
  156. package/docs/PhoneNumber.md +12 -12
  157. package/docs/PhoneNumberWebhookModel.md +12 -0
  158. package/docs/PlanApi.md +38 -38
  159. package/docs/PrefillField.md +12 -12
  160. package/docs/PrefillFieldRequest.md +12 -12
  161. package/docs/RecipientChangeLog.md +12 -12
  162. package/docs/RecipientNotificationSettings.md +22 -22
  163. package/docs/Rectangle.md +14 -14
  164. package/docs/ReminderMessage.md +13 -13
  165. package/docs/ReminderSettings.md +13 -13
  166. package/docs/RemoveAuthentication.md +14 -14
  167. package/docs/Removed.md +13 -13
  168. package/docs/RevokeDocument.md +12 -12
  169. package/docs/Role.md +36 -35
  170. package/docs/Roles.md +36 -36
  171. package/docs/SendForSign.md +49 -48
  172. package/docs/SendForSignFromTemplateForm.md +47 -46
  173. package/docs/SenderIdentitiesApi.md +243 -243
  174. package/docs/SenderIdentityCreated.md +11 -11
  175. package/docs/SenderIdentityCreator.md +14 -0
  176. package/docs/SenderIdentityEvent.md +23 -0
  177. package/docs/SenderIdentityList.md +12 -12
  178. package/docs/SenderIdentityViewModel.md +21 -21
  179. package/docs/SignatureFrameSettings.md +14 -14
  180. package/docs/SignerAuthenticationSettings.md +12 -12
  181. package/docs/SignerAuthenticationWebhookModel.md +12 -0
  182. package/docs/Size.md +12 -12
  183. package/docs/TeamCreated.md +11 -11
  184. package/docs/TeamDocumentRecords.md +12 -12
  185. package/docs/TeamListResponse.md +12 -12
  186. package/docs/TeamPageDetails.md +12 -12
  187. package/docs/TeamResponse.md +15 -15
  188. package/docs/TeamUpdateRequest.md +12 -12
  189. package/docs/TeamUsers.md +16 -16
  190. package/docs/Teams.md +14 -14
  191. package/docs/TeamsApi.md +141 -141
  192. package/docs/Template.md +29 -29
  193. package/docs/TemplateApi.md +588 -520
  194. package/docs/TemplateCC.md +12 -12
  195. package/docs/TemplateCcWebhookModel.md +13 -0
  196. package/docs/TemplateCreated.md +11 -11
  197. package/docs/TemplateEvent.md +36 -0
  198. package/docs/TemplateFiles.md +14 -14
  199. package/docs/TemplateFormFields.md +54 -53
  200. package/docs/TemplateGroupSigner.md +12 -12
  201. package/docs/TemplateGroupSignerWebhookModel.md +12 -0
  202. package/docs/TemplateProperties.md +43 -41
  203. package/docs/TemplateRecords.md +12 -12
  204. package/docs/TemplateRole.md +30 -30
  205. package/docs/TemplateSender.md +15 -0
  206. package/docs/TemplateSenderDetail.md +12 -12
  207. package/docs/TemplateSenderDetails.md +13 -13
  208. package/docs/TemplateShareErrorResponse.md +14 -0
  209. package/docs/TemplateShareRequest.md +11 -0
  210. package/docs/TemplateSharedTemplateDetail.md +12 -12
  211. package/docs/TemplateSharing.md +11 -11
  212. package/docs/TemplateSigner.md +29 -0
  213. package/docs/TemplateSignerDetails.md +29 -29
  214. package/docs/TemplateTag.md +14 -14
  215. package/docs/TemplateTeamShare.md +12 -12
  216. package/docs/TemplateTeamShareRequest.md +13 -0
  217. package/docs/TextTagDefinition.md +43 -42
  218. package/docs/TextTagOffset.md +12 -12
  219. package/docs/UpdateGroupContact.md +13 -13
  220. package/docs/UpdateUser.md +14 -14
  221. package/docs/UpdateUserMetaData.md +12 -12
  222. package/docs/UserApi.md +275 -275
  223. package/docs/UserPageDetails.md +12 -12
  224. package/docs/UserProperties.md +21 -21
  225. package/docs/UserRecords.md +12 -12
  226. package/docs/UsersDetails.md +21 -21
  227. package/docs/Validation.md +13 -13
  228. package/docs/VerificationDataRequest.md +15 -15
  229. package/docs/ViewBrandDetails.md +36 -36
  230. package/docs/ViewCustomFieldDetails.md +17 -17
  231. package/docs/WebhookActorDetails.md +12 -0
  232. package/docs/WebhookContext.md +13 -0
  233. package/docs/WebhookEvent.md +14 -0
  234. package/docs/WebhookEventMetadata.md +15 -0
  235. package/git_push.sh +57 -57
  236. package/model/accessCodeDetail.ts +99 -91
  237. package/model/accessCodeDetails.ts +44 -44
  238. package/model/added.ts +43 -43
  239. package/model/address.ts +61 -61
  240. package/model/attachmentInfo.ts +49 -49
  241. package/model/auditTrail.ts +207 -201
  242. package/model/authenticationSettings.ts +39 -39
  243. package/model/base64File.ts +37 -37
  244. package/model/behalfDocument.ts +154 -154
  245. package/model/behalfDocumentRecords.ts +39 -39
  246. package/model/behalfOf.ts +37 -37
  247. package/model/behalfOfWebhookModel.ts +37 -0
  248. package/model/billingViewModel.ts +31 -31
  249. package/model/brandCreated.ts +31 -31
  250. package/model/brandCustomFieldDetails.ts +62 -62
  251. package/model/brandingMessage.ts +31 -31
  252. package/model/brandingRecords.ts +32 -32
  253. package/model/changeRecipient.ts +74 -74
  254. package/model/changeTeamRequest.ts +37 -37
  255. package/model/checkboxValidationSettings.ts +51 -0
  256. package/model/collaborationSettings.ts +49 -49
  257. package/model/conditionalRule.ts +43 -43
  258. package/model/contactCreated.ts +37 -37
  259. package/model/contactDetails.ts +56 -56
  260. package/model/contactPageDetails.ts +43 -43
  261. package/model/contactsDetails.ts +62 -62
  262. package/model/contactsList.ts +39 -39
  263. package/model/createContactResponse.ts +32 -32
  264. package/model/createGroupContactResponse.ts +37 -37
  265. package/model/createSenderIdentityRequest.ts +93 -93
  266. package/model/createTeamRequest.ts +31 -31
  267. package/model/createTemplateRequest.ts +220 -214
  268. package/model/createUser.ts +56 -56
  269. package/model/creators.ts +37 -37
  270. package/model/customDomainSettings.ts +37 -37
  271. package/model/customFieldCollection.ts +32 -32
  272. package/model/customFieldMessage.ts +37 -37
  273. package/model/customFormField.ts +296 -282
  274. package/model/deleteCustomFieldReply.ts +31 -31
  275. package/model/document.ts +147 -147
  276. package/model/documentCC.ts +31 -31
  277. package/model/documentCcDetails.ts +37 -37
  278. package/model/documentCcWebhookModel.ts +37 -0
  279. package/model/documentCreated.ts +31 -31
  280. package/model/documentEdited.ts +37 -37
  281. package/model/documentEvent.ts +213 -0
  282. package/model/documentExpirySettings.ts +68 -68
  283. package/model/documentFiles.ts +61 -61
  284. package/model/documentFormFields.ts +316 -316
  285. package/model/documentGroupSignerWebhookModel.ts +83 -0
  286. package/model/documentInfo.ts +100 -100
  287. package/model/documentProperties.ts +370 -346
  288. package/model/documentReassign.ts +43 -43
  289. package/model/documentRecords.ts +39 -39
  290. package/model/documentSender.ts +49 -0
  291. package/model/documentSenderDetail.ts +49 -49
  292. package/model/documentSigner.ts +255 -247
  293. package/model/documentSignerDetails.ts +306 -298
  294. package/model/documentSignerWebhookModel.ts +202 -0
  295. package/model/documentTags.ts +37 -37
  296. package/model/downloadImageRequest.ts +61 -61
  297. package/model/editDocumentFile.ts +56 -56
  298. package/model/editDocumentRequest.ts +242 -236
  299. package/model/editDocumentSigner.ts +263 -255
  300. package/model/editFormField.ts +338 -338
  301. package/model/editSenderIdentityRequest.ts +81 -81
  302. package/model/editTemplateRequest.ts +189 -183
  303. package/model/editableDateFieldSettings.ts +49 -49
  304. package/model/embeddedCloneDocumentJsonRequest.ts +126 -0
  305. package/model/embeddedCloneTemplateJsonRequest.ts +126 -0
  306. package/model/embeddedClonedDocument.ts +37 -0
  307. package/model/embeddedClonedTemplate.ts +37 -0
  308. package/model/embeddedCreateTemplateRequest.ts +313 -307
  309. package/model/embeddedCustomFieldCreated.ts +31 -31
  310. package/model/embeddedDocumentEditJsonRequest.ts +108 -108
  311. package/model/embeddedDocumentEdited.ts +31 -31
  312. package/model/embeddedDocumentRequest.ts +370 -364
  313. package/model/embeddedFileDetails.ts +61 -61
  314. package/model/embeddedFileLink.ts +31 -31
  315. package/model/embeddedMergeTemplateFormRequest.ts +376 -370
  316. package/model/embeddedSendCreated.ts +37 -37
  317. package/model/embeddedSendTemplateFormRequest.ts +357 -351
  318. package/model/embeddedSigningLink.ts +31 -31
  319. package/model/embeddedTemplateCreated.ts +37 -37
  320. package/model/embeddedTemplateEditRequest.ts +120 -120
  321. package/model/embeddedTemplateEdited.ts +31 -31
  322. package/model/embeddedTemplatePreview.ts +31 -31
  323. package/model/embeddedTemplatePreviewJsonRequest.ts +37 -37
  324. package/model/errorResponse.ts +37 -0
  325. package/model/errorResult.ts +31 -31
  326. package/model/existingFormField.ts +55 -55
  327. package/model/extendExpiry.ts +49 -49
  328. package/model/fileInfo.ts +49 -49
  329. package/model/font.ts +88 -88
  330. package/model/formField.ts +340 -340
  331. package/model/formFieldPermission.ts +43 -43
  332. package/model/formFieldPermissionWebhookModel.ts +43 -0
  333. package/model/formGroup.ts +63 -63
  334. package/model/formulaFieldSettings.ts +37 -37
  335. package/model/getGroupContactDetails.ts +57 -57
  336. package/model/groupContact.ts +50 -50
  337. package/model/groupContactDetails.ts +44 -44
  338. package/model/groupContactsList.ts +39 -39
  339. package/model/groupOption.ts +37 -0
  340. package/model/groupSigner.ts +77 -77
  341. package/model/groupSignerSettings.ts +37 -37
  342. package/model/groupSignerSettingsWebhookModel.ts +37 -0
  343. package/model/groupUser.ts +37 -37
  344. package/model/iWebhookData.ts +335 -0
  345. package/model/idDocument.ts +93 -93
  346. package/model/idReport.ts +50 -50
  347. package/model/idVerificationDetails.ts +85 -85
  348. package/model/{idVerification.ts → idVerificationSignerWebhookModel.ts} +79 -79
  349. package/model/identityVerificationEvent.ts +80 -0
  350. package/model/identityVerificationSettings.ts +84 -84
  351. package/model/imageInfo.ts +43 -43
  352. package/model/index.ts +805 -666
  353. package/model/kbaAuthenticationEvent.ts +80 -0
  354. package/model/{problemDetails.ts → kbaDetails.ts} +49 -55
  355. package/model/kbaSettings.ts +57 -0
  356. package/model/kbaSignerWebhookModel.ts +49 -0
  357. package/model/mergeAndSendForSignForm.ts +289 -283
  358. package/model/modelDate.ts +43 -43
  359. package/model/modelError.ts +37 -37
  360. package/model/models.ts +244 -244
  361. package/model/modificationDetails.ts +37 -37
  362. package/model/notificationSettings.ts +97 -97
  363. package/model/pageDetails.ts +61 -61
  364. package/model/phoneNumber.ts +37 -37
  365. package/model/phoneNumberWebhookModel.ts +37 -0
  366. package/model/prefillField.ts +37 -37
  367. package/model/prefillFieldRequest.ts +38 -38
  368. package/model/recipientChangeLog.ts +39 -39
  369. package/model/recipientNotificationSettings.ts +97 -97
  370. package/model/rectangle.ts +49 -49
  371. package/model/reminderMessage.ts +44 -44
  372. package/model/reminderSettings.ts +43 -43
  373. package/model/removeAuthentication.ts +50 -50
  374. package/model/removed.ts +43 -43
  375. package/model/revokeDocument.ts +37 -37
  376. package/model/role.ts +262 -254
  377. package/model/roles.ts +259 -258
  378. package/model/sendForSign.ts +283 -277
  379. package/model/sendForSignFromTemplateForm.ts +270 -264
  380. package/model/senderIdentityCreated.ts +31 -31
  381. package/model/senderIdentityCreator.ts +49 -0
  382. package/model/senderIdentityEvent.ts +104 -0
  383. package/model/senderIdentityList.ts +39 -39
  384. package/model/senderIdentityViewModel.ts +92 -92
  385. package/model/signatureFrameSettings.ts +49 -49
  386. package/model/signerAuthenticationSettings.ts +37 -37
  387. package/model/signerAuthenticationWebhookModel.ts +37 -0
  388. package/model/size.ts +37 -37
  389. package/model/teamCreated.ts +31 -31
  390. package/model/teamDocumentRecords.ts +39 -39
  391. package/model/teamListResponse.ts +39 -39
  392. package/model/teamPageDetails.ts +37 -37
  393. package/model/teamResponse.ts +56 -56
  394. package/model/teamUpdateRequest.ts +37 -37
  395. package/model/teamUsers.ts +73 -73
  396. package/model/teams.ts +49 -49
  397. package/model/template.ts +159 -159
  398. package/model/templateCC.ts +37 -37
  399. package/model/templateCcWebhookModel.ts +43 -0
  400. package/model/templateCreated.ts +31 -31
  401. package/model/templateEvent.ts +198 -0
  402. package/model/templateFiles.ts +49 -49
  403. package/model/templateFormFields.ts +321 -315
  404. package/model/templateGroupSigner.ts +37 -37
  405. package/model/templateGroupSignerWebhookModel.ts +37 -0
  406. package/model/templateProperties.ts +246 -234
  407. package/model/templateRecords.ts +39 -39
  408. package/model/templateRole.ts +222 -221
  409. package/model/templateSender.ts +55 -0
  410. package/model/templateSenderDetail.ts +37 -37
  411. package/model/templateSenderDetails.ts +43 -43
  412. package/model/templateShareErrorResponse.ts +49 -0
  413. package/model/templateShareRequest.ts +32 -0
  414. package/model/templateSharedTemplateDetail.ts +43 -43
  415. package/model/templateSharing.ts +32 -32
  416. package/model/templateSigner.ts +151 -0
  417. package/model/templateSignerDetails.ts +174 -173
  418. package/model/templateTag.ts +49 -49
  419. package/model/templateTeamShare.ts +44 -44
  420. package/model/templateTeamShareRequest.ts +53 -0
  421. package/model/textTagDefinition.ts +268 -261
  422. package/model/textTagOffset.ts +37 -37
  423. package/model/updateGroupContact.ts +44 -44
  424. package/model/updateUser.ts +60 -60
  425. package/model/updateUserMetaData.ts +37 -37
  426. package/model/userPageDetails.ts +37 -37
  427. package/model/userProperties.ts +91 -91
  428. package/model/userRecords.ts +39 -39
  429. package/model/usersDetails.ts +91 -91
  430. package/model/validation.ts +52 -52
  431. package/model/verificationDataRequest.ts +55 -55
  432. package/model/viewBrandDetails.ts +190 -190
  433. package/model/viewCustomFieldDetails.ts +68 -68
  434. package/model/webhookActorDetails.ts +47 -0
  435. package/model/webhookContext.ts +82 -0
  436. package/model/webhookEvent.ts +53 -0
  437. package/model/webhookEventMetadata.ts +97 -0
  438. package/package.json +53 -53
  439. package/tsconfig.json +24 -24
  440. package/boldsign-3.1.4.tgz +0 -0
  441. package/dist/api/apis.d.ts +0 -29
  442. package/dist/api/apis.js +0 -149
  443. package/dist/api/apis.js.map +0 -1
  444. package/dist/api/brandingApi.d.ts +0 -29
  445. package/dist/api/brandingApi.js +0 -776
  446. package/dist/api/brandingApi.js.map +0 -1
  447. package/dist/api/contactsApi.d.ts +0 -28
  448. package/dist/api/contactsApi.js +0 -501
  449. package/dist/api/contactsApi.js.map +0 -1
  450. package/dist/api/customFieldApi.d.ts +0 -28
  451. package/dist/api/customFieldApi.js +0 -519
  452. package/dist/api/customFieldApi.js.map +0 -1
  453. package/dist/api/documentApi.d.ts +0 -48
  454. package/dist/api/documentApi.js +0 -2259
  455. package/dist/api/documentApi.js.map +0 -1
  456. package/dist/api/groupContactsApi.d.ts +0 -28
  457. package/dist/api/groupContactsApi.js +0 -507
  458. package/dist/api/groupContactsApi.js.map +0 -1
  459. package/dist/api/identityVerificationApi.d.ts +0 -26
  460. package/dist/api/identityVerificationApi.js +0 -369
  461. package/dist/api/identityVerificationApi.js.map +0 -1
  462. package/dist/api/index.d.ts +0 -14
  463. package/dist/api/index.js +0 -33
  464. package/dist/api/index.js.map +0 -1
  465. package/dist/api/planApi.d.ts +0 -24
  466. package/dist/api/planApi.js +0 -174
  467. package/dist/api/planApi.js.map +0 -1
  468. package/dist/api/senderIdentitiesApi.d.ts +0 -30
  469. package/dist/api/senderIdentitiesApi.js +0 -663
  470. package/dist/api/senderIdentitiesApi.js.map +0 -1
  471. package/dist/api/teamsApi.d.ts +0 -27
  472. package/dist/api/teamsApi.js +0 -426
  473. package/dist/api/teamsApi.js.map +0 -1
  474. package/dist/api/templateApi.d.ts +0 -38
  475. package/dist/api/templateApi.js +0 -1335
  476. package/dist/api/templateApi.js.map +0 -1
  477. package/dist/api/userApi.d.ts +0 -31
  478. package/dist/api/userApi.js +0 -723
  479. package/dist/api/userApi.js.map +0 -1
  480. package/dist/api.d.ts +0 -2
  481. package/dist/api.js +0 -19
  482. package/dist/api.js.map +0 -1
  483. package/dist/examples/DocumentProperties.d.ts +0 -1
  484. package/dist/examples/DocumentProperties.js +0 -28
  485. package/dist/examples/DocumentProperties.js.map +0 -1
  486. package/dist/examples/brandCreate.d.ts +0 -1
  487. package/dist/examples/brandCreate.js +0 -68
  488. package/dist/examples/brandCreate.js.map +0 -1
  489. package/dist/examples/brandDelete.d.ts +0 -1
  490. package/dist/examples/brandDelete.js +0 -28
  491. package/dist/examples/brandDelete.js.map +0 -1
  492. package/dist/examples/brandGet.d.ts +0 -1
  493. package/dist/examples/brandGet.js +0 -28
  494. package/dist/examples/brandGet.js.map +0 -1
  495. package/dist/examples/brandList.d.ts +0 -1
  496. package/dist/examples/brandList.js +0 -27
  497. package/dist/examples/brandList.js.map +0 -1
  498. package/dist/examples/brandResetDefault.d.ts +0 -1
  499. package/dist/examples/brandResetDefault.js +0 -28
  500. package/dist/examples/brandResetDefault.js.map +0 -1
  501. package/dist/examples/brandUpdate.d.ts +0 -1
  502. package/dist/examples/brandUpdate.js +0 -68
  503. package/dist/examples/brandUpdate.js.map +0 -1
  504. package/dist/examples/contactCreate.d.ts +0 -1
  505. package/dist/examples/contactCreate.js +0 -38
  506. package/dist/examples/contactCreate.js.map +0 -1
  507. package/dist/examples/contactDelete.d.ts +0 -1
  508. package/dist/examples/contactDelete.js +0 -28
  509. package/dist/examples/contactDelete.js.map +0 -1
  510. package/dist/examples/contactGet.d.ts +0 -1
  511. package/dist/examples/contactGet.js +0 -28
  512. package/dist/examples/contactGet.js.map +0 -1
  513. package/dist/examples/contactGroupDelete.d.ts +0 -1
  514. package/dist/examples/contactGroupDelete.js +0 -27
  515. package/dist/examples/contactGroupDelete.js.map +0 -1
  516. package/dist/examples/contactGroupGet.d.ts +0 -1
  517. package/dist/examples/contactGroupGet.js +0 -27
  518. package/dist/examples/contactGroupGet.js.map +0 -1
  519. package/dist/examples/contactGroupList.d.ts +0 -1
  520. package/dist/examples/contactGroupList.js +0 -29
  521. package/dist/examples/contactGroupList.js.map +0 -1
  522. package/dist/examples/contactGroupUpdate.d.ts +0 -1
  523. package/dist/examples/contactGroupUpdate.js +0 -34
  524. package/dist/examples/contactGroupUpdate.js.map +0 -1
  525. package/dist/examples/contactGroupsCreate.d.ts +0 -1
  526. package/dist/examples/contactGroupsCreate.js +0 -35
  527. package/dist/examples/contactGroupsCreate.js.map +0 -1
  528. package/dist/examples/contactList.d.ts +0 -1
  529. package/dist/examples/contactList.js +0 -29
  530. package/dist/examples/contactList.js.map +0 -1
  531. package/dist/examples/contactUpdate.d.ts +0 -1
  532. package/dist/examples/contactUpdate.js +0 -38
  533. package/dist/examples/contactUpdate.js.map +0 -1
  534. package/dist/examples/customFieldCreate.d.ts +0 -1
  535. package/dist/examples/customFieldCreate.js +0 -39
  536. package/dist/examples/customFieldCreate.js.map +0 -1
  537. package/dist/examples/customFieldDelete.d.ts +0 -1
  538. package/dist/examples/customFieldDelete.js +0 -28
  539. package/dist/examples/customFieldDelete.js.map +0 -1
  540. package/dist/examples/customFieldEdit.d.ts +0 -1
  541. package/dist/examples/customFieldEdit.js +0 -40
  542. package/dist/examples/customFieldEdit.js.map +0 -1
  543. package/dist/examples/customFieldEmbeddedCreateUrl.d.ts +0 -1
  544. package/dist/examples/customFieldEmbeddedCreateUrl.js +0 -31
  545. package/dist/examples/customFieldEmbeddedCreateUrl.js.map +0 -1
  546. package/dist/examples/customFieldList.d.ts +0 -1
  547. package/dist/examples/customFieldList.js +0 -28
  548. package/dist/examples/customFieldList.js.map +0 -1
  549. package/dist/examples/documentAddAuthentication.d.ts +0 -1
  550. package/dist/examples/documentAddAuthentication.js +0 -32
  551. package/dist/examples/documentAddAuthentication.js.map +0 -1
  552. package/dist/examples/documentAddTags.d.ts +0 -1
  553. package/dist/examples/documentAddTags.js +0 -31
  554. package/dist/examples/documentAddTags.js.map +0 -1
  555. package/dist/examples/documentCancelEditing.d.ts +0 -1
  556. package/dist/examples/documentCancelEditing.js +0 -27
  557. package/dist/examples/documentCancelEditing.js.map +0 -1
  558. package/dist/examples/documentChangeAccessCode.d.ts +0 -1
  559. package/dist/examples/documentChangeAccessCode.js +0 -32
  560. package/dist/examples/documentChangeAccessCode.js.map +0 -1
  561. package/dist/examples/documentChangeRecipients.d.ts +0 -1
  562. package/dist/examples/documentChangeRecipients.js +0 -34
  563. package/dist/examples/documentChangeRecipients.js.map +0 -1
  564. package/dist/examples/documentCreateEmbeddedEditUrl.d.ts +0 -1
  565. package/dist/examples/documentCreateEmbeddedEditUrl.js +0 -32
  566. package/dist/examples/documentCreateEmbeddedEditUrl.js.map +0 -1
  567. package/dist/examples/documentDelete.d.ts +0 -1
  568. package/dist/examples/documentDelete.js +0 -29
  569. package/dist/examples/documentDelete.js.map +0 -1
  570. package/dist/examples/documentDeleteTags.d.ts +0 -1
  571. package/dist/examples/documentDeleteTags.js +0 -31
  572. package/dist/examples/documentDeleteTags.js.map +0 -1
  573. package/dist/examples/documentDownload.d.ts +0 -1
  574. package/dist/examples/documentDownload.js +0 -29
  575. package/dist/examples/documentDownload.js.map +0 -1
  576. package/dist/examples/documentDownloadAttachment.d.ts +0 -1
  577. package/dist/examples/documentDownloadAttachment.js +0 -30
  578. package/dist/examples/documentDownloadAttachment.js.map +0 -1
  579. package/dist/examples/documentDownloadAuditTrial.d.ts +0 -1
  580. package/dist/examples/documentDownloadAuditTrial.js +0 -29
  581. package/dist/examples/documentDownloadAuditTrial.js.map +0 -1
  582. package/dist/examples/documentEdit.d.ts +0 -1
  583. package/dist/examples/documentEdit.js +0 -86
  584. package/dist/examples/documentEdit.js.map +0 -1
  585. package/dist/examples/documentEmbeddedRequestLink.d.ts +0 -1
  586. package/dist/examples/documentEmbeddedRequestLink.js +0 -96
  587. package/dist/examples/documentEmbeddedRequestLink.js.map +0 -1
  588. package/dist/examples/documentEmbeddedSignLink.d.ts +0 -1
  589. package/dist/examples/documentEmbeddedSignLink.js +0 -35
  590. package/dist/examples/documentEmbeddedSignLink.js.map +0 -1
  591. package/dist/examples/documentExtendExpiry.d.ts +0 -1
  592. package/dist/examples/documentExtendExpiry.js +0 -32
  593. package/dist/examples/documentExtendExpiry.js.map +0 -1
  594. package/dist/examples/documentList.d.ts +0 -1
  595. package/dist/examples/documentList.js +0 -29
  596. package/dist/examples/documentList.js.map +0 -1
  597. package/dist/examples/documentListBehalf.d.ts +0 -1
  598. package/dist/examples/documentListBehalf.js +0 -28
  599. package/dist/examples/documentListBehalf.js.map +0 -1
  600. package/dist/examples/documentListTeam.d.ts +0 -1
  601. package/dist/examples/documentListTeam.js +0 -28
  602. package/dist/examples/documentListTeam.js.map +0 -1
  603. package/dist/examples/documentPrefillFieldCheckBox.d.ts +0 -1
  604. package/dist/examples/documentPrefillFieldCheckBox.js +0 -34
  605. package/dist/examples/documentPrefillFieldCheckBox.js.map +0 -1
  606. package/dist/examples/documentPrefillFieldDropDown.d.ts +0 -1
  607. package/dist/examples/documentPrefillFieldDropDown.js +0 -34
  608. package/dist/examples/documentPrefillFieldDropDown.js.map +0 -1
  609. package/dist/examples/documentPrefillFieldEditableDate.d.ts +0 -1
  610. package/dist/examples/documentPrefillFieldEditableDate.js +0 -34
  611. package/dist/examples/documentPrefillFieldEditableDate.js.map +0 -1
  612. package/dist/examples/documentPrefillFieldImage.d.ts +0 -1
  613. package/dist/examples/documentPrefillFieldImage.js +0 -34
  614. package/dist/examples/documentPrefillFieldImage.js.map +0 -1
  615. package/dist/examples/documentPrefillFieldRadioButton.d.ts +0 -1
  616. package/dist/examples/documentPrefillFieldRadioButton.js +0 -34
  617. package/dist/examples/documentPrefillFieldRadioButton.js.map +0 -1
  618. package/dist/examples/documentPrefillFieldTextBox.d.ts +0 -1
  619. package/dist/examples/documentPrefillFieldTextBox.js +0 -34
  620. package/dist/examples/documentPrefillFieldTextBox.js.map +0 -1
  621. package/dist/examples/documentRemoveAuthentication.d.ts +0 -1
  622. package/dist/examples/documentRemoveAuthentication.js +0 -31
  623. package/dist/examples/documentRemoveAuthentication.js.map +0 -1
  624. package/dist/examples/documentRevoke.d.ts +0 -1
  625. package/dist/examples/documentRevoke.js +0 -31
  626. package/dist/examples/documentRevoke.js.map +0 -1
  627. package/dist/examples/documentSend.d.ts +0 -1
  628. package/dist/examples/documentSend.js +0 -90
  629. package/dist/examples/documentSend.js.map +0 -1
  630. package/dist/examples/documentSendOnBehalf.d.ts +0 -1
  631. package/dist/examples/documentSendOnBehalf.js +0 -101
  632. package/dist/examples/documentSendOnBehalf.js.map +0 -1
  633. package/dist/examples/documentSendReminder.d.ts +0 -1
  634. package/dist/examples/documentSendReminder.js +0 -32
  635. package/dist/examples/documentSendReminder.js.map +0 -1
  636. package/dist/examples/draftSend.d.ts +0 -1
  637. package/dist/examples/draftSend.js +0 -27
  638. package/dist/examples/draftSend.js.map +0 -1
  639. package/dist/examples/embeddedCreatePreviewUrl.d.ts +0 -1
  640. package/dist/examples/embeddedCreatePreviewUrl.js +0 -29
  641. package/dist/examples/embeddedCreatePreviewUrl.js.map +0 -1
  642. package/dist/examples/embeddedManualVerification.d.ts +0 -1
  643. package/dist/examples/embeddedManualVerification.js +0 -34
  644. package/dist/examples/embeddedManualVerification.js.map +0 -1
  645. package/dist/examples/identityVerificationImage.d.ts +0 -1
  646. package/dist/examples/identityVerificationImage.js +0 -34
  647. package/dist/examples/identityVerificationImage.js.map +0 -1
  648. package/dist/examples/identityVerificationReport.d.ts +0 -1
  649. package/dist/examples/identityVerificationReport.js +0 -33
  650. package/dist/examples/identityVerificationReport.js.map +0 -1
  651. package/dist/examples/listTemplate.d.ts +0 -1
  652. package/dist/examples/listTemplate.js +0 -29
  653. package/dist/examples/listTemplate.js.map +0 -1
  654. package/dist/examples/plan.d.ts +0 -1
  655. package/dist/examples/plan.js +0 -27
  656. package/dist/examples/plan.js.map +0 -1
  657. package/dist/examples/senderIdentityCreate.d.ts +0 -1
  658. package/dist/examples/senderIdentityCreate.js +0 -33
  659. package/dist/examples/senderIdentityCreate.js.map +0 -1
  660. package/dist/examples/senderIdentityDelete.d.ts +0 -1
  661. package/dist/examples/senderIdentityDelete.js +0 -28
  662. package/dist/examples/senderIdentityDelete.js.map +0 -1
  663. package/dist/examples/senderIdentityList.d.ts +0 -1
  664. package/dist/examples/senderIdentityList.js +0 -29
  665. package/dist/examples/senderIdentityList.js.map +0 -1
  666. package/dist/examples/senderIdentityProperties.d.ts +0 -1
  667. package/dist/examples/senderIdentityProperties.js +0 -27
  668. package/dist/examples/senderIdentityProperties.js.map +0 -1
  669. package/dist/examples/senderIdentityRerequest.d.ts +0 -1
  670. package/dist/examples/senderIdentityRerequest.js +0 -28
  671. package/dist/examples/senderIdentityRerequest.js.map +0 -1
  672. package/dist/examples/senderIdentityResendInvitation.d.ts +0 -1
  673. package/dist/examples/senderIdentityResendInvitation.js +0 -28
  674. package/dist/examples/senderIdentityResendInvitation.js.map +0 -1
  675. package/dist/examples/senderIdentityUpdate.d.ts +0 -1
  676. package/dist/examples/senderIdentityUpdate.js +0 -32
  677. package/dist/examples/senderIdentityUpdate.js.map +0 -1
  678. package/dist/examples/teamCreate.d.ts +0 -1
  679. package/dist/examples/teamCreate.js +0 -30
  680. package/dist/examples/teamCreate.js.map +0 -1
  681. package/dist/examples/teamGet.d.ts +0 -1
  682. package/dist/examples/teamGet.js +0 -28
  683. package/dist/examples/teamGet.js.map +0 -1
  684. package/dist/examples/teamList.d.ts +0 -1
  685. package/dist/examples/teamList.js +0 -29
  686. package/dist/examples/teamList.js.map +0 -1
  687. package/dist/examples/teamUpdate.d.ts +0 -1
  688. package/dist/examples/teamUpdate.js +0 -31
  689. package/dist/examples/teamUpdate.js.map +0 -1
  690. package/dist/examples/templateAddTag.d.ts +0 -1
  691. package/dist/examples/templateAddTag.js +0 -32
  692. package/dist/examples/templateAddTag.js.map +0 -1
  693. package/dist/examples/templateCreate.d.ts +0 -1
  694. package/dist/examples/templateCreate.js +0 -91
  695. package/dist/examples/templateCreate.js.map +0 -1
  696. package/dist/examples/templateDelete.d.ts +0 -1
  697. package/dist/examples/templateDelete.js +0 -28
  698. package/dist/examples/templateDelete.js.map +0 -1
  699. package/dist/examples/templateDeleteTag.d.ts +0 -1
  700. package/dist/examples/templateDeleteTag.js +0 -32
  701. package/dist/examples/templateDeleteTag.js.map +0 -1
  702. package/dist/examples/templateDetails.d.ts +0 -1
  703. package/dist/examples/templateDetails.js +0 -28
  704. package/dist/examples/templateDetails.js.map +0 -1
  705. package/dist/examples/templateDownload.d.ts +0 -1
  706. package/dist/examples/templateDownload.js +0 -28
  707. package/dist/examples/templateDownload.js.map +0 -1
  708. package/dist/examples/templateEdit.d.ts +0 -1
  709. package/dist/examples/templateEdit.js +0 -39
  710. package/dist/examples/templateEdit.js.map +0 -1
  711. package/dist/examples/templateEmbeddedCreate.d.ts +0 -1
  712. package/dist/examples/templateEmbeddedCreate.js +0 -76
  713. package/dist/examples/templateEmbeddedCreate.js.map +0 -1
  714. package/dist/examples/templateEmbeddedEdit.d.ts +0 -1
  715. package/dist/examples/templateEmbeddedEdit.js +0 -36
  716. package/dist/examples/templateEmbeddedEdit.js.map +0 -1
  717. package/dist/examples/templateEmbeddedRequestLink.d.ts +0 -1
  718. package/dist/examples/templateEmbeddedRequestLink.js +0 -78
  719. package/dist/examples/templateEmbeddedRequestLink.js.map +0 -1
  720. package/dist/examples/templateMergerEmbeddedRequestUrl.d.ts +0 -1
  721. package/dist/examples/templateMergerEmbeddedRequestUrl.js +0 -80
  722. package/dist/examples/templateMergerEmbeddedRequestUrl.js.map +0 -1
  723. package/dist/examples/templateSendDocument.d.ts +0 -1
  724. package/dist/examples/templateSendDocument.js +0 -102
  725. package/dist/examples/templateSendDocument.js.map +0 -1
  726. package/dist/examples/templateSendDocumentUsingMultipleTemplate.d.ts +0 -1
  727. package/dist/examples/templateSendDocumentUsingMultipleTemplate.js +0 -50
  728. package/dist/examples/templateSendDocumentUsingMultipleTemplate.js.map +0 -1
  729. package/dist/examples/userChangeTeam.d.ts +0 -1
  730. package/dist/examples/userChangeTeam.js +0 -30
  731. package/dist/examples/userChangeTeam.js.map +0 -1
  732. package/dist/examples/userCreate.d.ts +0 -1
  733. package/dist/examples/userCreate.js +0 -32
  734. package/dist/examples/userCreate.js.map +0 -1
  735. package/dist/examples/userGet.d.ts +0 -1
  736. package/dist/examples/userGet.js +0 -28
  737. package/dist/examples/userGet.js.map +0 -1
  738. package/dist/examples/userInvitationCancel.d.ts +0 -1
  739. package/dist/examples/userInvitationCancel.js +0 -28
  740. package/dist/examples/userInvitationCancel.js.map +0 -1
  741. package/dist/examples/userList.d.ts +0 -1
  742. package/dist/examples/userList.js +0 -29
  743. package/dist/examples/userList.js.map +0 -1
  744. package/dist/examples/userResendInvitation.d.ts +0 -1
  745. package/dist/examples/userResendInvitation.js +0 -28
  746. package/dist/examples/userResendInvitation.js.map +0 -1
  747. package/dist/examples/userUpdateRole.d.ts +0 -1
  748. package/dist/examples/userUpdateRole.js +0 -31
  749. package/dist/examples/userUpdateRole.js.map +0 -1
  750. package/dist/model/accessCodeDetail.d.ts +0 -34
  751. package/dist/model/accessCodeDetail.js +0 -68
  752. package/dist/model/accessCodeDetail.js.map +0 -1
  753. package/dist/model/accessCodeDetails.d.ts +0 -17
  754. package/dist/model/accessCodeDetails.js +0 -28
  755. package/dist/model/accessCodeDetails.js.map +0 -1
  756. package/dist/model/added.d.ts +0 -16
  757. package/dist/model/added.js +0 -28
  758. package/dist/model/added.js.map +0 -1
  759. package/dist/model/address.d.ts +0 -19
  760. package/dist/model/address.js +0 -43
  761. package/dist/model/address.js.map +0 -1
  762. package/dist/model/attachmentInfo.d.ts +0 -17
  763. package/dist/model/attachmentInfo.js +0 -33
  764. package/dist/model/attachmentInfo.js.map +0 -1
  765. package/dist/model/auditTrail.d.ts +0 -114
  766. package/dist/model/auditTrail.js +0 -173
  767. package/dist/model/auditTrail.js.map +0 -1
  768. package/dist/model/authenticationSettings.d.ts +0 -22
  769. package/dist/model/authenticationSettings.js +0 -27
  770. package/dist/model/authenticationSettings.js.map +0 -1
  771. package/dist/model/base64File.d.ts +0 -15
  772. package/dist/model/base64File.js +0 -23
  773. package/dist/model/base64File.js.map +0 -1
  774. package/dist/model/behalfDocument.d.ts +0 -47
  775. package/dist/model/behalfDocument.js +0 -120
  776. package/dist/model/behalfDocument.js.map +0 -1
  777. package/dist/model/behalfDocumentRecords.d.ts +0 -17
  778. package/dist/model/behalfDocumentRecords.js +0 -23
  779. package/dist/model/behalfDocumentRecords.js.map +0 -1
  780. package/dist/model/behalfOf.d.ts +0 -15
  781. package/dist/model/behalfOf.js +0 -23
  782. package/dist/model/behalfOf.js.map +0 -1
  783. package/dist/model/billingViewModel.d.ts +0 -14
  784. package/dist/model/billingViewModel.js +0 -18
  785. package/dist/model/billingViewModel.js.map +0 -1
  786. package/dist/model/brandCreated.d.ts +0 -14
  787. package/dist/model/brandCreated.js +0 -18
  788. package/dist/model/brandCreated.js.map +0 -1
  789. package/dist/model/brandCustomFieldDetails.d.ts +0 -20
  790. package/dist/model/brandCustomFieldDetails.js +0 -46
  791. package/dist/model/brandCustomFieldDetails.js.map +0 -1
  792. package/dist/model/brandingMessage.d.ts +0 -14
  793. package/dist/model/brandingMessage.js +0 -18
  794. package/dist/model/brandingMessage.js.map +0 -1
  795. package/dist/model/brandingRecords.d.ts +0 -15
  796. package/dist/model/brandingRecords.js +0 -18
  797. package/dist/model/brandingRecords.js.map +0 -1
  798. package/dist/model/changeRecipient.d.ts +0 -22
  799. package/dist/model/changeRecipient.js +0 -53
  800. package/dist/model/changeRecipient.js.map +0 -1
  801. package/dist/model/changeTeamRequest.d.ts +0 -15
  802. package/dist/model/changeTeamRequest.js +0 -23
  803. package/dist/model/changeTeamRequest.js.map +0 -1
  804. package/dist/model/collaborationSettings.d.ts +0 -17
  805. package/dist/model/collaborationSettings.js +0 -33
  806. package/dist/model/collaborationSettings.js.map +0 -1
  807. package/dist/model/conditionalRule.d.ts +0 -16
  808. package/dist/model/conditionalRule.js +0 -28
  809. package/dist/model/conditionalRule.js.map +0 -1
  810. package/dist/model/contactCreated.d.ts +0 -15
  811. package/dist/model/contactCreated.js +0 -23
  812. package/dist/model/contactCreated.js.map +0 -1
  813. package/dist/model/contactDetails.d.ts +0 -19
  814. package/dist/model/contactDetails.js +0 -38
  815. package/dist/model/contactDetails.js.map +0 -1
  816. package/dist/model/contactPageDetails.d.ts +0 -16
  817. package/dist/model/contactPageDetails.js +0 -28
  818. package/dist/model/contactPageDetails.js.map +0 -1
  819. package/dist/model/contactsDetails.d.ts +0 -20
  820. package/dist/model/contactsDetails.js +0 -43
  821. package/dist/model/contactsDetails.js.map +0 -1
  822. package/dist/model/contactsList.d.ts +0 -17
  823. package/dist/model/contactsList.js +0 -23
  824. package/dist/model/contactsList.js.map +0 -1
  825. package/dist/model/createContactResponse.d.ts +0 -15
  826. package/dist/model/createContactResponse.js +0 -18
  827. package/dist/model/createContactResponse.js.map +0 -1
  828. package/dist/model/createGroupContactResponse.d.ts +0 -15
  829. package/dist/model/createGroupContactResponse.js +0 -23
  830. package/dist/model/createGroupContactResponse.js.map +0 -1
  831. package/dist/model/createSenderIdentityRequest.d.ts +0 -48
  832. package/dist/model/createSenderIdentityRequest.js +0 -74
  833. package/dist/model/createSenderIdentityRequest.js.map +0 -1
  834. package/dist/model/createTeamRequest.d.ts +0 -14
  835. package/dist/model/createTeamRequest.js +0 -18
  836. package/dist/model/createTeamRequest.js.map +0 -1
  837. package/dist/model/createTemplateRequest.d.ts +0 -58
  838. package/dist/model/createTemplateRequest.js +0 -177
  839. package/dist/model/createTemplateRequest.js.map +0 -1
  840. package/dist/model/createUser.d.ts +0 -26
  841. package/dist/model/createUser.js +0 -41
  842. package/dist/model/createUser.js.map +0 -1
  843. package/dist/model/creators.d.ts +0 -15
  844. package/dist/model/creators.js +0 -23
  845. package/dist/model/creators.js.map +0 -1
  846. package/dist/model/customDomainSettings.d.ts +0 -15
  847. package/dist/model/customDomainSettings.js +0 -23
  848. package/dist/model/customDomainSettings.js.map +0 -1
  849. package/dist/model/customFieldCollection.d.ts +0 -15
  850. package/dist/model/customFieldCollection.js +0 -18
  851. package/dist/model/customFieldCollection.js.map +0 -1
  852. package/dist/model/customFieldMessage.d.ts +0 -15
  853. package/dist/model/customFieldMessage.js +0 -23
  854. package/dist/model/customFieldMessage.js.map +0 -1
  855. package/dist/model/customFormField.d.ts +0 -100
  856. package/dist/model/customFormField.js +0 -246
  857. package/dist/model/customFormField.js.map +0 -1
  858. package/dist/model/deleteCustomFieldReply.d.ts +0 -14
  859. package/dist/model/deleteCustomFieldReply.js +0 -18
  860. package/dist/model/deleteCustomFieldReply.js.map +0 -1
  861. package/dist/model/document.d.ts +0 -45
  862. package/dist/model/document.js +0 -115
  863. package/dist/model/document.js.map +0 -1
  864. package/dist/model/documentCC.d.ts +0 -14
  865. package/dist/model/documentCC.js +0 -18
  866. package/dist/model/documentCC.js.map +0 -1
  867. package/dist/model/documentCcDetails.d.ts +0 -15
  868. package/dist/model/documentCcDetails.js +0 -26
  869. package/dist/model/documentCcDetails.js.map +0 -1
  870. package/dist/model/documentCreated.d.ts +0 -14
  871. package/dist/model/documentCreated.js +0 -18
  872. package/dist/model/documentCreated.js.map +0 -1
  873. package/dist/model/documentEdited.d.ts +0 -20
  874. package/dist/model/documentEdited.js +0 -25
  875. package/dist/model/documentEdited.js.map +0 -1
  876. package/dist/model/documentExpirySettings.d.ts +0 -26
  877. package/dist/model/documentExpirySettings.js +0 -51
  878. package/dist/model/documentExpirySettings.js.map +0 -1
  879. package/dist/model/documentFiles.d.ts +0 -19
  880. package/dist/model/documentFiles.js +0 -43
  881. package/dist/model/documentFiles.js.map +0 -1
  882. package/dist/model/documentFormFields.d.ts +0 -89
  883. package/dist/model/documentFormFields.js +0 -260
  884. package/dist/model/documentFormFields.js.map +0 -1
  885. package/dist/model/documentInfo.d.ts +0 -65
  886. package/dist/model/documentInfo.js +0 -83
  887. package/dist/model/documentInfo.js.map +0 -1
  888. package/dist/model/documentProperties.d.ts +0 -116
  889. package/dist/model/documentProperties.js +0 -283
  890. package/dist/model/documentProperties.js.map +0 -1
  891. package/dist/model/documentReassign.d.ts +0 -16
  892. package/dist/model/documentReassign.js +0 -31
  893. package/dist/model/documentReassign.js.map +0 -1
  894. package/dist/model/documentRecords.d.ts +0 -17
  895. package/dist/model/documentRecords.js +0 -23
  896. package/dist/model/documentRecords.js.map +0 -1
  897. package/dist/model/documentSenderDetail.d.ts +0 -17
  898. package/dist/model/documentSenderDetail.js +0 -36
  899. package/dist/model/documentSenderDetail.js.map +0 -1
  900. package/dist/model/documentSigner.d.ts +0 -112
  901. package/dist/model/documentSigner.js +0 -209
  902. package/dist/model/documentSigner.js.map +0 -1
  903. package/dist/model/documentSignerDetails.d.ts +0 -128
  904. package/dist/model/documentSignerDetails.js +0 -261
  905. package/dist/model/documentSignerDetails.js.map +0 -1
  906. package/dist/model/documentTags.d.ts +0 -15
  907. package/dist/model/documentTags.js +0 -23
  908. package/dist/model/documentTags.js.map +0 -1
  909. package/dist/model/downloadImageRequest.d.ts +0 -19
  910. package/dist/model/downloadImageRequest.js +0 -43
  911. package/dist/model/downloadImageRequest.js.map +0 -1
  912. package/dist/model/editDocumentFile.d.ts +0 -25
  913. package/dist/model/editDocumentFile.js +0 -41
  914. package/dist/model/editDocumentFile.js.map +0 -1
  915. package/dist/model/editDocumentRequest.d.ts +0 -71
  916. package/dist/model/editDocumentRequest.js +0 -187
  917. package/dist/model/editDocumentRequest.js.map +0 -1
  918. package/dist/model/editDocumentSigner.d.ts +0 -118
  919. package/dist/model/editDocumentSigner.js +0 -220
  920. package/dist/model/editDocumentSigner.js.map +0 -1
  921. package/dist/model/editFormField.d.ts +0 -116
  922. package/dist/model/editFormField.js +0 -288
  923. package/dist/model/editFormField.js.map +0 -1
  924. package/dist/model/editSenderIdentityRequest.d.ts +0 -46
  925. package/dist/model/editSenderIdentityRequest.js +0 -64
  926. package/dist/model/editSenderIdentityRequest.js.map +0 -1
  927. package/dist/model/editTemplateRequest.d.ts +0 -51
  928. package/dist/model/editTemplateRequest.js +0 -141
  929. package/dist/model/editTemplateRequest.js.map +0 -1
  930. package/dist/model/editableDateFieldSettings.d.ts +0 -17
  931. package/dist/model/editableDateFieldSettings.js +0 -33
  932. package/dist/model/editableDateFieldSettings.js.map +0 -1
  933. package/dist/model/embeddedCreateTemplateRequest.d.ts +0 -96
  934. package/dist/model/embeddedCreateTemplateRequest.js +0 -269
  935. package/dist/model/embeddedCreateTemplateRequest.js.map +0 -1
  936. package/dist/model/embeddedCustomFieldCreated.d.ts +0 -14
  937. package/dist/model/embeddedCustomFieldCreated.js +0 -18
  938. package/dist/model/embeddedCustomFieldCreated.js.map +0 -1
  939. package/dist/model/embeddedDocumentEditJsonRequest.d.ts +0 -51
  940. package/dist/model/embeddedDocumentEditJsonRequest.js +0 -97
  941. package/dist/model/embeddedDocumentEditJsonRequest.js.map +0 -1
  942. package/dist/model/embeddedDocumentEdited.d.ts +0 -14
  943. package/dist/model/embeddedDocumentEdited.js +0 -18
  944. package/dist/model/embeddedDocumentEdited.js.map +0 -1
  945. package/dist/model/embeddedDocumentRequest.d.ts +0 -115
  946. package/dist/model/embeddedDocumentRequest.js +0 -322
  947. package/dist/model/embeddedDocumentRequest.js.map +0 -1
  948. package/dist/model/embeddedFileDetails.d.ts +0 -19
  949. package/dist/model/embeddedFileDetails.js +0 -43
  950. package/dist/model/embeddedFileDetails.js.map +0 -1
  951. package/dist/model/embeddedFileLink.d.ts +0 -14
  952. package/dist/model/embeddedFileLink.js +0 -18
  953. package/dist/model/embeddedFileLink.js.map +0 -1
  954. package/dist/model/embeddedMergeTemplateFormRequest.d.ts +0 -116
  955. package/dist/model/embeddedMergeTemplateFormRequest.js +0 -311
  956. package/dist/model/embeddedMergeTemplateFormRequest.js.map +0 -1
  957. package/dist/model/embeddedSendCreated.d.ts +0 -15
  958. package/dist/model/embeddedSendCreated.js +0 -23
  959. package/dist/model/embeddedSendCreated.js.map +0 -1
  960. package/dist/model/embeddedSendTemplateFormRequest.d.ts +0 -112
  961. package/dist/model/embeddedSendTemplateFormRequest.js +0 -296
  962. package/dist/model/embeddedSendTemplateFormRequest.js.map +0 -1
  963. package/dist/model/embeddedSigningLink.d.ts +0 -14
  964. package/dist/model/embeddedSigningLink.js +0 -18
  965. package/dist/model/embeddedSigningLink.js.map +0 -1
  966. package/dist/model/embeddedTemplateCreated.d.ts +0 -15
  967. package/dist/model/embeddedTemplateCreated.js +0 -23
  968. package/dist/model/embeddedTemplateCreated.js.map +0 -1
  969. package/dist/model/embeddedTemplateEditRequest.d.ts +0 -53
  970. package/dist/model/embeddedTemplateEditRequest.js +0 -109
  971. package/dist/model/embeddedTemplateEditRequest.js.map +0 -1
  972. package/dist/model/embeddedTemplateEdited.d.ts +0 -14
  973. package/dist/model/embeddedTemplateEdited.js +0 -18
  974. package/dist/model/embeddedTemplateEdited.js.map +0 -1
  975. package/dist/model/embeddedTemplatePreview.d.ts +0 -14
  976. package/dist/model/embeddedTemplatePreview.js +0 -18
  977. package/dist/model/embeddedTemplatePreview.js.map +0 -1
  978. package/dist/model/embeddedTemplatePreviewJsonRequest.d.ts +0 -15
  979. package/dist/model/embeddedTemplatePreviewJsonRequest.js +0 -23
  980. package/dist/model/embeddedTemplatePreviewJsonRequest.js.map +0 -1
  981. package/dist/model/errorResult.d.ts +0 -14
  982. package/dist/model/errorResult.js +0 -18
  983. package/dist/model/errorResult.js.map +0 -1
  984. package/dist/model/existingFormField.d.ts +0 -18
  985. package/dist/model/existingFormField.js +0 -38
  986. package/dist/model/existingFormField.js.map +0 -1
  987. package/dist/model/extendExpiry.d.ts +0 -17
  988. package/dist/model/extendExpiry.js +0 -33
  989. package/dist/model/extendExpiry.js.map +0 -1
  990. package/dist/model/fileInfo.d.ts +0 -17
  991. package/dist/model/fileInfo.js +0 -33
  992. package/dist/model/fileInfo.js.map +0 -1
  993. package/dist/model/font.d.ts +0 -36
  994. package/dist/model/font.js +0 -70
  995. package/dist/model/font.js.map +0 -1
  996. package/dist/model/formField.d.ts +0 -113
  997. package/dist/model/formField.js +0 -287
  998. package/dist/model/formField.js.map +0 -1
  999. package/dist/model/formFieldPermission.d.ts +0 -16
  1000. package/dist/model/formFieldPermission.js +0 -28
  1001. package/dist/model/formFieldPermission.js.map +0 -1
  1002. package/dist/model/formGroup.d.ts +0 -26
  1003. package/dist/model/formGroup.js +0 -47
  1004. package/dist/model/formGroup.js.map +0 -1
  1005. package/dist/model/formulaFieldSettings.d.ts +0 -15
  1006. package/dist/model/formulaFieldSettings.js +0 -26
  1007. package/dist/model/formulaFieldSettings.js.map +0 -1
  1008. package/dist/model/getGroupContactDetails.d.ts +0 -20
  1009. package/dist/model/getGroupContactDetails.js +0 -38
  1010. package/dist/model/getGroupContactDetails.js.map +0 -1
  1011. package/dist/model/groupContact.d.ts +0 -18
  1012. package/dist/model/groupContact.js +0 -33
  1013. package/dist/model/groupContact.js.map +0 -1
  1014. package/dist/model/groupContactDetails.d.ts +0 -17
  1015. package/dist/model/groupContactDetails.js +0 -28
  1016. package/dist/model/groupContactDetails.js.map +0 -1
  1017. package/dist/model/groupContactsList.d.ts +0 -17
  1018. package/dist/model/groupContactsList.js +0 -23
  1019. package/dist/model/groupContactsList.js.map +0 -1
  1020. package/dist/model/groupSigner.d.ts +0 -30
  1021. package/dist/model/groupSigner.js +0 -59
  1022. package/dist/model/groupSigner.js.map +0 -1
  1023. package/dist/model/groupSignerSettings.d.ts +0 -15
  1024. package/dist/model/groupSignerSettings.js +0 -23
  1025. package/dist/model/groupSignerSettings.js.map +0 -1
  1026. package/dist/model/groupUser.d.ts +0 -15
  1027. package/dist/model/groupUser.js +0 -23
  1028. package/dist/model/groupUser.js.map +0 -1
  1029. package/dist/model/idDocument.d.ts +0 -26
  1030. package/dist/model/idDocument.js +0 -68
  1031. package/dist/model/idDocument.js.map +0 -1
  1032. package/dist/model/idReport.d.ts +0 -18
  1033. package/dist/model/idReport.js +0 -33
  1034. package/dist/model/idReport.js.map +0 -1
  1035. package/dist/model/idVerification.d.ts +0 -22
  1036. package/dist/model/idVerification.js +0 -58
  1037. package/dist/model/idVerification.js.map +0 -1
  1038. package/dist/model/idVerificationDetails.d.ts +0 -23
  1039. package/dist/model/idVerificationDetails.js +0 -63
  1040. package/dist/model/idVerificationDetails.js.map +0 -1
  1041. package/dist/model/identityVerificationSettings.d.ts +0 -37
  1042. package/dist/model/identityVerificationSettings.js +0 -68
  1043. package/dist/model/identityVerificationSettings.js.map +0 -1
  1044. package/dist/model/imageInfo.d.ts +0 -16
  1045. package/dist/model/imageInfo.js +0 -28
  1046. package/dist/model/imageInfo.js.map +0 -1
  1047. package/dist/model/index.d.ts +0 -170
  1048. package/dist/model/index.js +0 -651
  1049. package/dist/model/index.js.map +0 -1
  1050. package/dist/model/mergeAndSendForSignForm.d.ts +0 -79
  1051. package/dist/model/mergeAndSendForSignForm.js +0 -232
  1052. package/dist/model/mergeAndSendForSignForm.js.map +0 -1
  1053. package/dist/model/modelDate.d.ts +0 -16
  1054. package/dist/model/modelDate.js +0 -28
  1055. package/dist/model/modelDate.js.map +0 -1
  1056. package/dist/model/modelError.d.ts +0 -15
  1057. package/dist/model/modelError.js +0 -23
  1058. package/dist/model/modelError.js.map +0 -1
  1059. package/dist/model/models.d.ts +0 -56
  1060. package/dist/model/models.js +0 -212
  1061. package/dist/model/models.js.map +0 -1
  1062. package/dist/model/modificationDetails.d.ts +0 -15
  1063. package/dist/model/modificationDetails.js +0 -23
  1064. package/dist/model/modificationDetails.js.map +0 -1
  1065. package/dist/model/notificationSettings.d.ts +0 -25
  1066. package/dist/model/notificationSettings.js +0 -87
  1067. package/dist/model/notificationSettings.js.map +0 -1
  1068. package/dist/model/pageDetails.d.ts +0 -19
  1069. package/dist/model/pageDetails.js +0 -43
  1070. package/dist/model/pageDetails.js.map +0 -1
  1071. package/dist/model/phoneNumber.d.ts +0 -15
  1072. package/dist/model/phoneNumber.js +0 -23
  1073. package/dist/model/phoneNumber.js.map +0 -1
  1074. package/dist/model/prefillField.d.ts +0 -15
  1075. package/dist/model/prefillField.js +0 -23
  1076. package/dist/model/prefillField.js.map +0 -1
  1077. package/dist/model/prefillFieldRequest.d.ts +0 -16
  1078. package/dist/model/prefillFieldRequest.js +0 -23
  1079. package/dist/model/prefillFieldRequest.js.map +0 -1
  1080. package/dist/model/problemDetails.d.ts +0 -18
  1081. package/dist/model/problemDetails.js +0 -38
  1082. package/dist/model/problemDetails.js.map +0 -1
  1083. package/dist/model/recipientChangeLog.d.ts +0 -17
  1084. package/dist/model/recipientChangeLog.js +0 -23
  1085. package/dist/model/recipientChangeLog.js.map +0 -1
  1086. package/dist/model/recipientNotificationSettings.d.ts +0 -25
  1087. package/dist/model/recipientNotificationSettings.js +0 -86
  1088. package/dist/model/recipientNotificationSettings.js.map +0 -1
  1089. package/dist/model/rectangle.d.ts +0 -17
  1090. package/dist/model/rectangle.js +0 -39
  1091. package/dist/model/rectangle.js.map +0 -1
  1092. package/dist/model/reminderMessage.d.ts +0 -17
  1093. package/dist/model/reminderMessage.js +0 -28
  1094. package/dist/model/reminderMessage.js.map +0 -1
  1095. package/dist/model/reminderSettings.d.ts +0 -16
  1096. package/dist/model/reminderSettings.js +0 -33
  1097. package/dist/model/reminderSettings.js.map +0 -1
  1098. package/dist/model/removeAuthentication.d.ts +0 -18
  1099. package/dist/model/removeAuthentication.js +0 -33
  1100. package/dist/model/removeAuthentication.js.map +0 -1
  1101. package/dist/model/removed.d.ts +0 -16
  1102. package/dist/model/removed.js +0 -28
  1103. package/dist/model/removed.js.map +0 -1
  1104. package/dist/model/revokeDocument.d.ts +0 -15
  1105. package/dist/model/revokeDocument.js +0 -23
  1106. package/dist/model/revokeDocument.js.map +0 -1
  1107. package/dist/model/role.d.ts +0 -114
  1108. package/dist/model/role.js +0 -214
  1109. package/dist/model/role.js.map +0 -1
  1110. package/dist/model/roles.d.ts +0 -113
  1111. package/dist/model/roles.js +0 -219
  1112. package/dist/model/roles.js.map +0 -1
  1113. package/dist/model/sendForSign.d.ts +0 -78
  1114. package/dist/model/sendForSign.js +0 -235
  1115. package/dist/model/sendForSign.js.map +0 -1
  1116. package/dist/model/sendForSignFromTemplateForm.d.ts +0 -75
  1117. package/dist/model/sendForSignFromTemplateForm.js +0 -217
  1118. package/dist/model/sendForSignFromTemplateForm.js.map +0 -1
  1119. package/dist/model/senderIdentityCreated.d.ts +0 -14
  1120. package/dist/model/senderIdentityCreated.js +0 -18
  1121. package/dist/model/senderIdentityCreated.js.map +0 -1
  1122. package/dist/model/senderIdentityList.d.ts +0 -17
  1123. package/dist/model/senderIdentityList.js +0 -23
  1124. package/dist/model/senderIdentityList.js.map +0 -1
  1125. package/dist/model/senderIdentityViewModel.d.ts +0 -27
  1126. package/dist/model/senderIdentityViewModel.js +0 -68
  1127. package/dist/model/senderIdentityViewModel.js.map +0 -1
  1128. package/dist/model/signatureFrameSettings.d.ts +0 -17
  1129. package/dist/model/signatureFrameSettings.js +0 -39
  1130. package/dist/model/signatureFrameSettings.js.map +0 -1
  1131. package/dist/model/signerAuthenticationSettings.d.ts +0 -15
  1132. package/dist/model/signerAuthenticationSettings.js +0 -23
  1133. package/dist/model/signerAuthenticationSettings.js.map +0 -1
  1134. package/dist/model/size.d.ts +0 -15
  1135. package/dist/model/size.js +0 -27
  1136. package/dist/model/size.js.map +0 -1
  1137. package/dist/model/teamCreated.d.ts +0 -14
  1138. package/dist/model/teamCreated.js +0 -18
  1139. package/dist/model/teamCreated.js.map +0 -1
  1140. package/dist/model/teamDocumentRecords.d.ts +0 -17
  1141. package/dist/model/teamDocumentRecords.js +0 -23
  1142. package/dist/model/teamDocumentRecords.js.map +0 -1
  1143. package/dist/model/teamListResponse.d.ts +0 -17
  1144. package/dist/model/teamListResponse.js +0 -23
  1145. package/dist/model/teamListResponse.js.map +0 -1
  1146. package/dist/model/teamPageDetails.d.ts +0 -15
  1147. package/dist/model/teamPageDetails.js +0 -23
  1148. package/dist/model/teamPageDetails.js.map +0 -1
  1149. package/dist/model/teamResponse.d.ts +0 -19
  1150. package/dist/model/teamResponse.js +0 -38
  1151. package/dist/model/teamResponse.js.map +0 -1
  1152. package/dist/model/teamUpdateRequest.d.ts +0 -15
  1153. package/dist/model/teamUpdateRequest.js +0 -23
  1154. package/dist/model/teamUpdateRequest.js.map +0 -1
  1155. package/dist/model/teamUsers.d.ts +0 -31
  1156. package/dist/model/teamUsers.js +0 -57
  1157. package/dist/model/teamUsers.js.map +0 -1
  1158. package/dist/model/teams.d.ts +0 -17
  1159. package/dist/model/teams.js +0 -33
  1160. package/dist/model/teams.js.map +0 -1
  1161. package/dist/model/template.d.ts +0 -52
  1162. package/dist/model/template.js +0 -129
  1163. package/dist/model/template.js.map +0 -1
  1164. package/dist/model/templateCC.d.ts +0 -15
  1165. package/dist/model/templateCC.js +0 -23
  1166. package/dist/model/templateCC.js.map +0 -1
  1167. package/dist/model/templateCreated.d.ts +0 -14
  1168. package/dist/model/templateCreated.js +0 -18
  1169. package/dist/model/templateCreated.js.map +0 -1
  1170. package/dist/model/templateFiles.d.ts +0 -17
  1171. package/dist/model/templateFiles.js +0 -33
  1172. package/dist/model/templateFiles.js.map +0 -1
  1173. package/dist/model/templateFormFields.d.ts +0 -88
  1174. package/dist/model/templateFormFields.js +0 -260
  1175. package/dist/model/templateFormFields.js.map +0 -1
  1176. package/dist/model/templateGroupSigner.d.ts +0 -15
  1177. package/dist/model/templateGroupSigner.js +0 -23
  1178. package/dist/model/templateGroupSigner.js.map +0 -1
  1179. package/dist/model/templateProperties.d.ts +0 -67
  1180. package/dist/model/templateProperties.js +0 -181
  1181. package/dist/model/templateProperties.js.map +0 -1
  1182. package/dist/model/templateRecords.d.ts +0 -17
  1183. package/dist/model/templateRecords.js +0 -23
  1184. package/dist/model/templateRecords.js.map +0 -1
  1185. package/dist/model/templateRole.d.ts +0 -106
  1186. package/dist/model/templateRole.js +0 -189
  1187. package/dist/model/templateRole.js.map +0 -1
  1188. package/dist/model/templateSenderDetail.d.ts +0 -15
  1189. package/dist/model/templateSenderDetail.js +0 -23
  1190. package/dist/model/templateSenderDetail.js.map +0 -1
  1191. package/dist/model/templateSenderDetails.d.ts +0 -16
  1192. package/dist/model/templateSenderDetails.js +0 -28
  1193. package/dist/model/templateSenderDetails.js.map +0 -1
  1194. package/dist/model/templateSharedTemplateDetail.d.ts +0 -21
  1195. package/dist/model/templateSharedTemplateDetail.js +0 -30
  1196. package/dist/model/templateSharedTemplateDetail.js.map +0 -1
  1197. package/dist/model/templateSharing.d.ts +0 -15
  1198. package/dist/model/templateSharing.js +0 -18
  1199. package/dist/model/templateSharing.js.map +0 -1
  1200. package/dist/model/templateSignerDetails.d.ts +0 -66
  1201. package/dist/model/templateSignerDetails.js +0 -149
  1202. package/dist/model/templateSignerDetails.js.map +0 -1
  1203. package/dist/model/templateTag.d.ts +0 -17
  1204. package/dist/model/templateTag.js +0 -33
  1205. package/dist/model/templateTag.js.map +0 -1
  1206. package/dist/model/templateTeamShare.d.ts +0 -22
  1207. package/dist/model/templateTeamShare.js +0 -31
  1208. package/dist/model/templateTeamShare.js.map +0 -1
  1209. package/dist/model/textTagDefinition.d.ts +0 -89
  1210. package/dist/model/textTagDefinition.js +0 -216
  1211. package/dist/model/textTagDefinition.js.map +0 -1
  1212. package/dist/model/textTagOffset.d.ts +0 -15
  1213. package/dist/model/textTagOffset.js +0 -23
  1214. package/dist/model/textTagOffset.js.map +0 -1
  1215. package/dist/model/updateGroupContact.d.ts +0 -17
  1216. package/dist/model/updateGroupContact.js +0 -28
  1217. package/dist/model/updateGroupContact.js.map +0 -1
  1218. package/dist/model/updateUser.d.ts +0 -28
  1219. package/dist/model/updateUser.js +0 -46
  1220. package/dist/model/updateUser.js.map +0 -1
  1221. package/dist/model/updateUserMetaData.d.ts +0 -17
  1222. package/dist/model/updateUserMetaData.js +0 -23
  1223. package/dist/model/updateUserMetaData.js.map +0 -1
  1224. package/dist/model/userPageDetails.d.ts +0 -15
  1225. package/dist/model/userPageDetails.js +0 -23
  1226. package/dist/model/userPageDetails.js.map +0 -1
  1227. package/dist/model/userProperties.d.ts +0 -26
  1228. package/dist/model/userProperties.js +0 -68
  1229. package/dist/model/userProperties.js.map +0 -1
  1230. package/dist/model/userRecords.d.ts +0 -17
  1231. package/dist/model/userRecords.js +0 -23
  1232. package/dist/model/userRecords.js.map +0 -1
  1233. package/dist/model/usersDetails.d.ts +0 -26
  1234. package/dist/model/usersDetails.js +0 -68
  1235. package/dist/model/usersDetails.js.map +0 -1
  1236. package/dist/model/validation.d.ts +0 -25
  1237. package/dist/model/validation.js +0 -38
  1238. package/dist/model/validation.js.map +0 -1
  1239. package/dist/model/verificationDataRequest.d.ts +0 -18
  1240. package/dist/model/verificationDataRequest.js +0 -38
  1241. package/dist/model/verificationDataRequest.js.map +0 -1
  1242. package/dist/model/viewBrandDetails.d.ts +0 -48
  1243. package/dist/model/viewBrandDetails.js +0 -150
  1244. package/dist/model/viewBrandDetails.js.map +0 -1
  1245. package/dist/model/viewCustomFieldDetails.d.ts +0 -21
  1246. package/dist/model/viewCustomFieldDetails.js +0 -48
  1247. package/dist/model/viewCustomFieldDetails.js.map +0 -1
  1248. package/dist/tests/config.d.ts +0 -5
  1249. package/dist/tests/config.js +0 -43
  1250. package/dist/tests/config.js.map +0 -1
  1251. package/dist/tests/integration/BrandingApiTest.spec.d.ts +0 -1
  1252. package/dist/tests/integration/BrandingApiTest.spec.js +0 -310
  1253. package/dist/tests/integration/BrandingApiTest.spec.js.map +0 -1
  1254. package/dist/tests/integration/ContactsApiTest.spec.d.ts +0 -1
  1255. package/dist/tests/integration/ContactsApiTest.spec.js +0 -249
  1256. package/dist/tests/integration/ContactsApiTest.spec.js.map +0 -1
  1257. package/dist/tests/integration/CustomFieldApiTest.spec.d.ts +0 -1
  1258. package/dist/tests/integration/CustomFieldApiTest.spec.js +0 -289
  1259. package/dist/tests/integration/CustomFieldApiTest.spec.js.map +0 -1
  1260. package/dist/tests/integration/DocumentApiTest.spec.d.ts +0 -1
  1261. package/dist/tests/integration/DocumentApiTest.spec.js +0 -1710
  1262. package/dist/tests/integration/DocumentApiTest.spec.js.map +0 -1
  1263. package/dist/tests/integration/IdentityVerificationApiTest.spec.d.ts +0 -1
  1264. package/dist/tests/integration/IdentityVerificationApiTest.spec.js +0 -160
  1265. package/dist/tests/integration/IdentityVerificationApiTest.spec.js.map +0 -1
  1266. package/dist/tests/integration/TemplateApiTest.spec.d.ts +0 -1
  1267. package/dist/tests/integration/TemplateApiTest.spec.js +0 -1518
  1268. package/dist/tests/integration/TemplateApiTest.spec.js.map +0 -1
  1269. package/dist/tests/integration/planApiTest.spec.d.ts +0 -1
  1270. package/dist/tests/integration/planApiTest.spec.js +0 -41
  1271. package/dist/tests/integration/planApiTest.spec.js.map +0 -1
  1272. package/dist/tests/integration/senderIdentity.spec.d.ts +0 -1
  1273. package/dist/tests/integration/senderIdentity.spec.js +0 -481
  1274. package/dist/tests/integration/senderIdentity.spec.js.map +0 -1
  1275. package/dist/tests/integration/teamsApiTest.spec.d.ts +0 -1
  1276. package/dist/tests/integration/teamsApiTest.spec.js +0 -230
  1277. package/dist/tests/integration/teamsApiTest.spec.js.map +0 -1
  1278. package/dist/tests/integration/usersApiTest.spec.d.ts +0 -1
  1279. package/dist/tests/integration/usersApiTest.spec.js +0 -290
  1280. package/dist/tests/integration/usersApiTest.spec.js.map +0 -1
  1281. package/dist/tests/performance/performanceApiTest.spec.d.ts +0 -1
  1282. package/dist/tests/performance/performanceApiTest.spec.js +0 -368
  1283. package/dist/tests/performance/performanceApiTest.spec.js.map +0 -1
  1284. package/dist/tests/unit/brandingApi.spec.d.ts +0 -1
  1285. package/dist/tests/unit/brandingApi.spec.js +0 -174
  1286. package/dist/tests/unit/brandingApi.spec.js.map +0 -1
  1287. package/dist/tests/unit/contactsApi.spec.d.ts +0 -1
  1288. package/dist/tests/unit/contactsApi.spec.js +0 -154
  1289. package/dist/tests/unit/contactsApi.spec.js.map +0 -1
  1290. package/dist/tests/unit/customFieldApi.spec.d.ts +0 -1
  1291. package/dist/tests/unit/customFieldApi.spec.js +0 -140
  1292. package/dist/tests/unit/customFieldApi.spec.js.map +0 -1
  1293. package/dist/tests/unit/documentApi.spec.d.ts +0 -1
  1294. package/dist/tests/unit/documentApi.spec.js +0 -476
  1295. package/dist/tests/unit/documentApi.spec.js.map +0 -1
  1296. package/dist/tests/unit/planApi.spec.d.ts +0 -1
  1297. package/dist/tests/unit/planApi.spec.js +0 -69
  1298. package/dist/tests/unit/planApi.spec.js.map +0 -1
  1299. package/dist/tests/unit/senderIdentitiesApi.spec.d.ts +0 -1
  1300. package/dist/tests/unit/senderIdentitiesApi.spec.js +0 -148
  1301. package/dist/tests/unit/senderIdentitiesApi.spec.js.map +0 -1
  1302. package/dist/tests/unit/teamApi.spec.d.ts +0 -1
  1303. package/dist/tests/unit/teamApi.spec.js +0 -116
  1304. package/dist/tests/unit/teamApi.spec.js.map +0 -1
  1305. package/dist/tests/unit/templateApi.spec.d.ts +0 -1
  1306. package/dist/tests/unit/templateApi.spec.js +0 -285
  1307. package/dist/tests/unit/templateApi.spec.js.map +0 -1
  1308. package/dist/tests/unit/userApi.spec.d.ts +0 -1
  1309. package/dist/tests/unit/userApi.spec.js +0 -163
  1310. package/dist/tests/unit/userApi.spec.js.map +0 -1
  1311. package/examples/DocumentProperties.ts +0 -15
  1312. package/examples/brandCreate.ts +0 -29
  1313. package/examples/brandDelete.ts +0 -15
  1314. package/examples/brandGet.ts +0 -15
  1315. package/examples/brandList.ts +0 -14
  1316. package/examples/brandResetDefault.ts +0 -15
  1317. package/examples/brandUpdate.ts +0 -21
  1318. package/examples/contactCreate.ts +0 -26
  1319. package/examples/contactDelete.ts +0 -15
  1320. package/examples/contactGet.ts +0 -15
  1321. package/examples/contactGroupDelete.ts +0 -14
  1322. package/examples/contactGroupGet.ts +0 -14
  1323. package/examples/contactGroupList.ts +0 -16
  1324. package/examples/contactGroupUpdate.ts +0 -21
  1325. package/examples/contactGroupsCreate.ts +0 -24
  1326. package/examples/contactList.ts +0 -16
  1327. package/examples/contactUpdate.ts +0 -26
  1328. package/examples/customFieldCreate.ts +0 -28
  1329. package/examples/customFieldDelete.ts +0 -15
  1330. package/examples/customFieldEdit.ts +0 -30
  1331. package/examples/customFieldEmbeddedCreateUrl.ts +0 -19
  1332. package/examples/customFieldList.ts +0 -15
  1333. package/examples/documentAddAuthentication.ts +0 -20
  1334. package/examples/documentAddTags.ts +0 -19
  1335. package/examples/documentCancelEditing.ts +0 -14
  1336. package/examples/documentChangeAccessCode.ts +0 -20
  1337. package/examples/documentChangeRecipients.ts +0 -22
  1338. package/examples/documentCreateEmbeddedEditUrl.ts +0 -19
  1339. package/examples/documentDelete.ts +0 -16
  1340. package/examples/documentDeleteTags.ts +0 -19
  1341. package/examples/documentDownload.ts +0 -16
  1342. package/examples/documentDownloadAttachment.ts +0 -17
  1343. package/examples/documentDownloadAuditTrial.ts +0 -16
  1344. package/examples/documentEdit.ts +0 -43
  1345. package/examples/documentEmbeddedRequestLink.ts +0 -49
  1346. package/examples/documentEmbeddedSignLink.ts +0 -23
  1347. package/examples/documentExtendExpiry.ts +0 -20
  1348. package/examples/documentList.ts +0 -19
  1349. package/examples/documentListBehalf.ts +0 -15
  1350. package/examples/documentListTeam.ts +0 -15
  1351. package/examples/documentPrefillFieldCheckBox.ts +0 -23
  1352. package/examples/documentPrefillFieldDropDown.ts +0 -23
  1353. package/examples/documentPrefillFieldEditableDate.ts +0 -23
  1354. package/examples/documentPrefillFieldImage.ts +0 -23
  1355. package/examples/documentPrefillFieldRadioButton.ts +0 -23
  1356. package/examples/documentPrefillFieldTextBox.ts +0 -23
  1357. package/examples/documentRemoveAuthentication.ts +0 -19
  1358. package/examples/documentRevoke.ts +0 -19
  1359. package/examples/documentSend.ts +0 -51
  1360. package/examples/documentSendOnBehalf.ts +0 -53
  1361. package/examples/documentSendReminder.ts +0 -20
  1362. package/examples/documents/agreement.pdf +0 -0
  1363. package/examples/documents/logo.jpg +0 -0
  1364. package/examples/draftSend.ts +0 -12
  1365. package/examples/embeddedCreatePreviewUrl.ts +0 -15
  1366. package/examples/embeddedManualVerification.ts +0 -22
  1367. package/examples/identityVerificationImage.ts +0 -23
  1368. package/examples/identityVerificationReport.ts +0 -21
  1369. package/examples/listTemplate.ts +0 -16
  1370. package/examples/plan.ts +0 -14
  1371. package/examples/senderIdentityCreate.ts +0 -21
  1372. package/examples/senderIdentityDelete.ts +0 -15
  1373. package/examples/senderIdentityList.ts +0 -16
  1374. package/examples/senderIdentityProperties.ts +0 -15
  1375. package/examples/senderIdentityRerequest.ts +0 -15
  1376. package/examples/senderIdentityResendInvitation.ts +0 -15
  1377. package/examples/senderIdentityUpdate.ts +0 -20
  1378. package/examples/teamCreate.ts +0 -18
  1379. package/examples/teamGet.ts +0 -15
  1380. package/examples/teamList.ts +0 -16
  1381. package/examples/teamUpdate.ts +0 -19
  1382. package/examples/templateAddTag.ts +0 -20
  1383. package/examples/templateCreate.ts +0 -47
  1384. package/examples/templateDelete.ts +0 -15
  1385. package/examples/templateDeleteTag.ts +0 -20
  1386. package/examples/templateDetails.ts +0 -15
  1387. package/examples/templateDownload.ts +0 -15
  1388. package/examples/templateEdit.ts +0 -28
  1389. package/examples/templateEmbeddedCreate.ts +0 -29
  1390. package/examples/templateEmbeddedEdit.ts +0 -24
  1391. package/examples/templateEmbeddedRequestLink.ts +0 -34
  1392. package/examples/templateMergerEmbeddedRequestUrl.ts +0 -37
  1393. package/examples/templateSendDocument.ts +0 -60
  1394. package/examples/templateSendDocumentUsingMultipleTemplate.ts +0 -40
  1395. package/examples/userChangeTeam.ts +0 -15
  1396. package/examples/userCreate.ts +0 -20
  1397. package/examples/userGet.ts +0 -15
  1398. package/examples/userInvitationCancel.ts +0 -15
  1399. package/examples/userList.ts +0 -16
  1400. package/examples/userResendInvitation.ts +0 -15
  1401. package/examples/userUpdateRole.ts +0 -19
  1402. package/tests/config.ts +0 -20
  1403. package/tests/documents/agreement.pdf +0 -0
  1404. package/tests/documents/logo.jpg +0 -0
  1405. package/tests/integration/BrandingApiTest.spec.ts +0 -254
  1406. package/tests/integration/ContactsApiTest.spec.ts +0 -222
  1407. package/tests/integration/CustomFieldApiTest.spec.ts +0 -231
  1408. package/tests/integration/DocumentApiTest.spec.ts +0 -1624
  1409. package/tests/integration/IdentityVerificationApiTest.spec.ts +0 -114
  1410. package/tests/integration/TemplateApiTest.spec.ts +0 -1420
  1411. package/tests/integration/planApiTest.spec.ts +0 -26
  1412. package/tests/integration/senderIdentity.spec.ts +0 -397
  1413. package/tests/integration/teamsApiTest.spec.ts +0 -226
  1414. package/tests/integration/usersApiTest.spec.ts +0 -251
  1415. package/tests/performance/performanceApiTest.spec.ts +0 -362
  1416. package/tests/unit/brandingApi.spec.ts +0 -163
  1417. package/tests/unit/contactsApi.spec.ts +0 -143
  1418. package/tests/unit/customFieldApi.spec.ts +0 -123
  1419. package/tests/unit/documentApi.spec.ts +0 -545
  1420. package/tests/unit/planApi.spec.ts +0 -34
  1421. package/tests/unit/senderIdentitiesApi.spec.ts +0 -148
  1422. package/tests/unit/teamApi.spec.ts +0 -94
  1423. package/tests/unit/templateApi.spec.ts +0 -307
  1424. package/tests/unit/userApi.spec.ts +0 -162
@@ -1,891 +1,925 @@
1
- # DocumentApi
2
-
3
- All URIs are relative to https://api.boldsign.com.
4
-
5
- | Method | HTTP request | Description |
6
- | ------------- | ------------- | ------------- |
7
- | [**addAuthentication()**](DocumentApi.md#addAuthentication) | **PATCH** /v1/document/addAuthentication | The add authentication to recipient. |
8
- | [**addTag()**](DocumentApi.md#addTag) | **PATCH** /v1/document/addTags | Add the Tags in Documents. |
9
- | [**behalfDocuments()**](DocumentApi.md#behalfDocuments) | **GET** /v1/document/behalfList | Gets the behalf documents. |
10
- | [**cancelEditing()**](DocumentApi.md#cancelEditing) | **POST** /v1/document/cancelEditing | Cancels editing for a document that is currently in edit-mode. |
11
- | [**changeAccessCode()**](DocumentApi.md#changeAccessCode) | **PATCH** /v1/document/changeAccessCode | Changes the access code for the given document signer. |
12
- | [**changeRecipient()**](DocumentApi.md#changeRecipient) | **PATCH** /v1/document/changeRecipient | Change recipient details of a document. |
13
- | [**createEmbeddedEditUrl()**](DocumentApi.md#createEmbeddedEditUrl) | **POST** /v1/document/createEmbeddedEditUrl | Generates an embedded edit URL that allows the document editing process to be integrated into your application. |
14
- | [**createEmbeddedRequestUrlDocument()**](DocumentApi.md#createEmbeddedRequestUrlDocument) | **POST** /v1/document/createEmbeddedRequestUrl | Generates a send URL which embeds document sending process into your application. |
15
- | [**deleteDocument()**](DocumentApi.md#deleteDocument) | **DELETE** /v1/document/delete | Delete the document. |
16
- | [**deleteTag()**](DocumentApi.md#deleteTag) | **DELETE** /v1/document/deleteTags | Delete the Tags in Documents. |
17
- | [**downloadAttachment()**](DocumentApi.md#downloadAttachment) | **GET** /v1/document/downloadAttachment | Download the Attachment. |
18
- | [**downloadAuditLog()**](DocumentApi.md#downloadAuditLog) | **GET** /v1/document/downloadAuditLog | Download the audit trail document. |
19
- | [**downloadDocument()**](DocumentApi.md#downloadDocument) | **GET** /v1/document/download | Download the document. |
20
- | [**draftSend()**](DocumentApi.md#draftSend) | **POST** /v1/document/draftSend | Sends a draft-status document out for signature. |
21
- | [**editDocument()**](DocumentApi.md#editDocument) | **PUT** /v1/document/edit | Edit and updates an existing document. |
22
- | [**extendExpiry()**](DocumentApi.md#extendExpiry) | **PATCH** /v1/document/extendExpiry | Extends the expiration date of the document. |
23
- | [**getProperties()**](DocumentApi.md#getProperties) | **GET** /v1/document/properties | Get summary of the document. |
24
- | [**getEmbeddedSignLink()**](DocumentApi.md#getEmbeddedSignLink) | **GET** /v1/document/getEmbeddedSignLink | Get sign link for Embedded Sign. |
25
- | [**listDocuments()**](DocumentApi.md#listDocuments) | **GET** /v1/document/list | List user documents. |
26
- | [**prefillFields()**](DocumentApi.md#prefillFields) | **PATCH** /v1/document/prefillFields | Updates the value (prefill) of the fields in the document. |
27
- | [**remindDocument()**](DocumentApi.md#remindDocument) | **POST** /v1/document/remind | Send reminder to pending signers. |
28
- | [**removeAuthentication()**](DocumentApi.md#removeAuthentication) | **PATCH** /v1/document/RemoveAuthentication | Remove the access code for the given document signer. |
29
- | [**revokeDocument()**](DocumentApi.md#revokeDocument) | **POST** /v1/document/revoke | Revoke the document. |
30
- | [**sendDocument()**](DocumentApi.md#sendDocument) | **POST** /v1/document/send | Sends the document for sign. |
31
- | [**teamDocuments()**](DocumentApi.md#teamDocuments) | **GET** /v1/document/teamlist | Get user Team documents. |
32
-
33
-
34
- ## `addAuthentication()`
35
-
36
- ```typescript
37
- addAuthentication(documentId: string, accessCodeDetail: AccessCodeDetail)
38
- ```
39
-
40
- The add authentication to recipient.
41
-
42
-
43
- ### Parameters
44
-
45
- |Name | Type | Description | Notes |
46
- | ------------- | ------------- | ------------- | ------------- |
47
- | **documentId** | **string**| The DocumentId. | |
48
- | **accessCodeDetail** | [**AccessCodeDetail**](../docs/AccessCodeDetail.md)| Access code details. | [optional] |
49
-
50
- ### Return type
51
-
52
- void (empty response body)
53
-
54
- ### Authorization
55
-
56
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
57
-
58
- ### HTTP request headers
59
-
60
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
61
- - **Accept**: `application/json`
62
-
63
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
64
- [[Back to Model list]](../README.md#models)
65
- [[Back to README]](../README.md)
66
-
67
- ## `addTag()`
68
-
69
- ```typescript
70
- addTag(documentTags: DocumentTags)
71
- ```
72
-
73
- Add the Tags in Documents.
74
-
75
-
76
- ### Parameters
77
-
78
- |Name | Type | Description | Notes |
79
- | ------------- | ------------- | ------------- | ------------- |
80
- | **documentTags** | [**DocumentTags**](../docs/DocumentTags.md)| Contains DocumentId and LabelNames for Adding Tags. | [optional] |
81
-
82
- ### Return type
83
-
84
- void (empty response body)
85
-
86
- ### Authorization
87
-
88
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
89
-
90
- ### HTTP request headers
91
-
92
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
93
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
94
-
95
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
96
- [[Back to Model list]](../README.md#models)
97
- [[Back to README]](../README.md)
98
-
99
- ## `behalfDocuments()`
100
-
101
- ```typescript
102
- behalfDocuments(page: number, pageType: 'BehalfOfOthers' | 'BehalfOfMe', emailAddress: Array<string>, signers: Array<string>, pageSize: number, startDate: Date, status: Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>, endDate: Date, searchKey: string, labels: Array<string>, nextCursor: number, brandIds: Array<string>): BehalfDocumentRecords
103
- ```
104
-
105
- Gets the behalf documents.
106
-
107
-
108
- ### Parameters
109
-
110
- |Name | Type | Description | Notes |
111
- | ------------- | ------------- | ------------- | ------------- |
112
- | **page** | **number**| Page index specified in get document list request. | [default to 1] |
113
- | **pageType** | **'BehalfOfOthers' | 'BehalfOfMe'**| The filter used to differentiate between documents sent on the user\&#39;s behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. | [optional] |
114
- | **emailAddress** | [**Array<string>**](../docs/string.md)| The sender identity\&#39;s email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. | [optional] |
115
- | **signers** | [**Array<string>**](../docs/string.md)| A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer\&#39;s email address matches one of the email addresses provided in this list | [optional] |
116
- | **pageSize** | **number**| Page size specified in get document list request. | [optional] [default to 10] |
117
- | **startDate** | **Date**| Start date of the document | [optional] |
118
- | **status** | [**Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>**](../docs/string.md)| Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. | [optional] |
119
- | **endDate** | **Date**| End date of the document | [optional] |
120
- | **searchKey** | **string**| Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., | [optional] |
121
- | **labels** | [**Array<string>**](../docs/string.md)| Labels of the document. | [optional] |
122
- | **nextCursor** | **number**| Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. | [optional] |
123
- | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the document. | [optional] |
124
-
125
- ### Return type
126
-
127
- [**BehalfDocumentRecords**](../docs/BehalfDocumentRecords.md)
128
-
129
- ### Authorization
130
-
131
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
132
-
133
- ### HTTP request headers
134
-
135
- - **Content-Type**: Not defined
136
- - **Accept**: `application/json`
137
-
138
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
139
- [[Back to Model list]](../README.md#models)
140
- [[Back to README]](../README.md)
141
-
142
- ## `cancelEditing()`
143
-
144
- ```typescript
145
- cancelEditing(documentId: string, onBehalfOf: string)
146
- ```
147
-
148
- Cancels editing for a document that is currently in edit-mode.
149
-
150
-
151
- ### Parameters
152
-
153
- |Name | Type | Description | Notes |
154
- | ------------- | ------------- | ------------- | ------------- |
155
- | **documentId** | **string**| The document id. | |
156
- | **onBehalfOf** | **string**| The onbehalfof email id. | [optional] |
157
-
158
- ### Return type
159
-
160
- void (empty response body)
161
-
162
- ### Authorization
163
-
164
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
165
-
166
- ### HTTP request headers
167
-
168
- - **Content-Type**: Not defined
169
- - **Accept**: `application/json`
170
-
171
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
172
- [[Back to Model list]](../README.md#models)
173
- [[Back to README]](../README.md)
174
-
175
- ## `changeAccessCode()`
176
-
177
- ```typescript
178
- changeAccessCode(documentId: string, accessCodeDetails: AccessCodeDetails, emailId: string, zOrder: number)
179
- ```
180
-
181
- Changes the access code for the given document signer.
182
-
183
-
184
- ### Parameters
185
-
186
- |Name | Type | Description | Notes |
187
- | ------------- | ------------- | ------------- | ------------- |
188
- | **documentId** | **string**| | |
189
- | **accessCodeDetails** | [**AccessCodeDetails**](../docs/AccessCodeDetails.md)| The new access code. | |
190
- | **emailId** | **string**| | [optional] |
191
- | **zOrder** | **number**| | [optional] |
192
-
193
- ### Return type
194
-
195
- void (empty response body)
196
-
197
- ### Authorization
198
-
199
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
200
-
201
- ### HTTP request headers
202
-
203
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
204
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
205
-
206
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
207
- [[Back to Model list]](../README.md#models)
208
- [[Back to README]](../README.md)
209
-
210
- ## `changeRecipient()`
211
-
212
- ```typescript
213
- changeRecipient(documentId: string, changeRecipient: ChangeRecipient)
214
- ```
215
-
216
- Change recipient details of a document.
217
-
218
-
219
- ### Parameters
220
-
221
- |Name | Type | Description | Notes |
222
- | ------------- | ------------- | ------------- | ------------- |
223
- | **documentId** | **string**| The documentID details. | |
224
- | **changeRecipient** | [**ChangeRecipient**](../docs/ChangeRecipient.md)| The new recipient details. | |
225
-
226
- ### Return type
227
-
228
- void (empty response body)
229
-
230
- ### Authorization
231
-
232
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
233
-
234
- ### HTTP request headers
235
-
236
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
237
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
238
-
239
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
240
- [[Back to Model list]](../README.md#models)
241
- [[Back to README]](../README.md)
242
-
243
- ## `createEmbeddedEditUrl()`
244
-
245
- ```typescript
246
- createEmbeddedEditUrl(documentId: string, embeddedDocumentEditJsonRequest: EmbeddedDocumentEditJsonRequest): EmbeddedDocumentEdited
247
- ```
248
-
249
- Generates an embedded edit URL that allows the document editing process to be integrated into your application.
250
-
251
-
252
- ### Parameters
253
-
254
- |Name | Type | Description | Notes |
255
- | ------------- | ------------- | ------------- | ------------- |
256
- | **documentId** | **string**| The document id. | |
257
- | **embeddedDocumentEditJsonRequest** | [**EmbeddedDocumentEditJsonRequest**](../docs/EmbeddedDocumentEditJsonRequest.md)| The embedded edit document request body. | [optional] |
258
-
259
- ### Return type
260
-
261
- [**EmbeddedDocumentEdited**](../docs/EmbeddedDocumentEdited.md)
262
-
263
- ### Authorization
264
-
265
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
266
-
267
- ### HTTP request headers
268
-
269
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
270
- - **Accept**: `application/json`
271
-
272
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
273
- [[Back to Model list]](../README.md#models)
274
- [[Back to README]](../README.md)
275
-
276
- ## `createEmbeddedRequestUrlDocument()`
277
-
278
- ```typescript
279
- createEmbeddedRequestUrlDocument(embeddedDocumentRequest: EmbeddedDocumentRequest): EmbeddedSendCreated
280
- ```
281
-
282
- Generates a send URL which embeds document sending process into your application.
283
-
284
-
285
- ### Parameters
286
-
287
- |Name | Type | Description | Notes |
288
- | ------------- | ------------- | ------------- | ------------- |
289
- | **embeddedDocumentRequest** | [**EmbeddedDocumentRequest**](../docs/EmbeddedDocumentRequest.md)| The embedded send document request body. | [optional] |
290
-
291
- ### Return type
292
-
293
- [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
294
-
295
- ### Authorization
296
-
297
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
298
-
299
- ### HTTP request headers
300
-
301
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
302
- - **Accept**: `application/json`
303
-
304
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
305
- [[Back to Model list]](../README.md#models)
306
- [[Back to README]](../README.md)
307
-
308
- ## `deleteDocument()`
309
-
310
- ```typescript
311
- deleteDocument(documentId: string, deletePermanently: boolean)
312
- ```
313
-
314
- Delete the document.
315
-
316
-
317
- ### Parameters
318
-
319
- |Name | Type | Description | Notes |
320
- | ------------- | ------------- | ------------- | ------------- |
321
- | **documentId** | **string**| Document Id. | |
322
- | **deletePermanently** | **boolean**| Delete Permanently. | [optional] [default to false] |
323
-
324
- ### Return type
325
-
326
- void (empty response body)
327
-
328
- ### Authorization
329
-
330
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
331
-
332
- ### HTTP request headers
333
-
334
- - **Content-Type**: Not defined
335
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
336
-
337
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
338
- [[Back to Model list]](../README.md#models)
339
- [[Back to README]](../README.md)
340
-
341
- ## `deleteTag()`
342
-
343
- ```typescript
344
- deleteTag(documentTags: DocumentTags)
345
- ```
346
-
347
- Delete the Tags in Documents.
348
-
349
-
350
- ### Parameters
351
-
352
- |Name | Type | Description | Notes |
353
- | ------------- | ------------- | ------------- | ------------- |
354
- | **documentTags** | [**DocumentTags**](../docs/DocumentTags.md)| Contains DocumentId and LabelNames for Adding Tags. | [optional] |
355
-
356
- ### Return type
357
-
358
- void (empty response body)
359
-
360
- ### Authorization
361
-
362
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
363
-
364
- ### HTTP request headers
365
-
366
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
367
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
368
-
369
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
370
- [[Back to Model list]](../README.md#models)
371
- [[Back to README]](../README.md)
372
-
373
- ## `downloadAttachment()`
374
-
375
- ```typescript
376
- downloadAttachment(documentId: string, attachmentId: string, onBehalfOf: string): Buffer
377
- ```
378
-
379
- Download the Attachment.
380
-
381
-
382
- ### Parameters
383
-
384
- |Name | Type | Description | Notes |
385
- | ------------- | ------------- | ------------- | ------------- |
386
- | **documentId** | **string**| Document Id. | |
387
- | **attachmentId** | **string**| Attachment Id(Get attachment ID from Properties API). | |
388
- | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
389
-
390
- ### Return type
391
-
392
- **Buffer**
393
-
394
- ### Authorization
395
-
396
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
397
-
398
- ### HTTP request headers
399
-
400
- - **Content-Type**: Not defined
401
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
402
-
403
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
404
- [[Back to Model list]](../README.md#models)
405
- [[Back to README]](../README.md)
406
-
407
- ## `downloadAuditLog()`
408
-
409
- ```typescript
410
- downloadAuditLog(documentId: string, onBehalfOf: string): Buffer
411
- ```
412
-
413
- Download the audit trail document.
414
-
415
-
416
- ### Parameters
417
-
418
- |Name | Type | Description | Notes |
419
- | ------------- | ------------- | ------------- | ------------- |
420
- | **documentId** | **string**| Document Id. | |
421
- | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
422
-
423
- ### Return type
424
-
425
- **Buffer**
426
-
427
- ### Authorization
428
-
429
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
430
-
431
- ### HTTP request headers
432
-
433
- - **Content-Type**: Not defined
434
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
435
-
436
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
437
- [[Back to Model list]](../README.md#models)
438
- [[Back to README]](../README.md)
439
-
440
- ## `downloadDocument()`
441
-
442
- ```typescript
443
- downloadDocument(documentId: string, onBehalfOf: string): Buffer
444
- ```
445
-
446
- Download the document.
447
-
448
-
449
- ### Parameters
450
-
451
- |Name | Type | Description | Notes |
452
- | ------------- | ------------- | ------------- | ------------- |
453
- | **documentId** | **string**| Document Id. | |
454
- | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
455
-
456
- ### Return type
457
-
458
- **Buffer**
459
-
460
- ### Authorization
461
-
462
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
463
-
464
- ### HTTP request headers
465
-
466
- - **Content-Type**: Not defined
467
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
468
-
469
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
470
- [[Back to Model list]](../README.md#models)
471
- [[Back to README]](../README.md)
472
-
473
- ## `draftSend()`
474
-
475
- ```typescript
476
- draftSend(documentId: string)
477
- ```
478
-
479
- Sends a draft-status document out for signature.
480
-
481
-
482
- ### Parameters
483
-
484
- |Name | Type | Description | Notes |
485
- | ------------- | ------------- | ------------- | ------------- |
486
- | **documentId** | **string**| The ID of the document to be sent. | |
487
-
488
- ### Return type
489
-
490
- void (empty response body)
491
-
492
- ### Authorization
493
-
494
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
495
-
496
- ### HTTP request headers
497
-
498
- - **Content-Type**: Not defined
499
- - **Accept**: `application/json`
500
-
501
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
502
- [[Back to Model list]](../README.md#models)
503
- [[Back to README]](../README.md)
504
-
505
- ## `editDocument()`
506
-
507
- ```typescript
508
- editDocument(documentId: string, editDocumentRequest: EditDocumentRequest): DocumentEdited
509
- ```
510
-
511
- Edit and updates an existing document.
512
-
513
-
514
- ### Parameters
515
-
516
- |Name | Type | Description | Notes |
517
- | ------------- | ------------- | ------------- | ------------- |
518
- | **documentId** | **string**| Document Id. | |
519
- | **editDocumentRequest** | [**EditDocumentRequest**](../docs/EditDocumentRequest.md)| Edit document JSON request. | [optional] |
520
-
521
- ### Return type
522
-
523
- [**DocumentEdited**](../docs/DocumentEdited.md)
524
-
525
- ### Authorization
526
-
527
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
528
-
529
- ### HTTP request headers
530
-
531
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
532
- - **Accept**: `application/json`
533
-
534
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
535
- [[Back to Model list]](../README.md#models)
536
- [[Back to README]](../README.md)
537
-
538
- ## `extendExpiry()`
539
-
540
- ```typescript
541
- extendExpiry(documentId: string, extendExpiry: ExtendExpiry)
542
- ```
543
-
544
- Extends the expiration date of the document.
545
-
546
-
547
- ### Parameters
548
-
549
- |Name | Type | Description | Notes |
550
- | ------------- | ------------- | ------------- | ------------- |
551
- | **documentId** | **string**| Document Id. | |
552
- | **extendExpiry** | [**ExtendExpiry**](../docs/ExtendExpiry.md)| The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. | [optional] |
553
-
554
- ### Return type
555
-
556
- void (empty response body)
557
-
558
- ### Authorization
559
-
560
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
561
-
562
- ### HTTP request headers
563
-
564
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
565
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
566
-
567
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
568
- [[Back to Model list]](../README.md#models)
569
- [[Back to README]](../README.md)
570
-
571
- ## `getProperties()`
572
-
573
- ```typescript
574
- getProperties(documentId: string): DocumentProperties
575
- ```
576
-
577
- Get summary of the document.
578
-
579
-
580
- ### Parameters
581
-
582
- |Name | Type | Description | Notes |
583
- | ------------- | ------------- | ------------- | ------------- |
584
- | **documentId** | **string**| Document Id. | |
585
-
586
- ### Return type
587
-
588
- [**DocumentProperties**](../docs/DocumentProperties.md)
589
-
590
- ### Authorization
591
-
592
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
593
-
594
- ### HTTP request headers
595
-
596
- - **Content-Type**: Not defined
597
- - **Accept**: `application/json`
598
-
599
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
600
- [[Back to Model list]](../README.md#models)
601
- [[Back to README]](../README.md)
602
-
603
- ## `getEmbeddedSignLink()`
604
-
605
- ```typescript
606
- getEmbeddedSignLink(documentId: string, signerEmail: string, countryCode: string, phoneNumber: string, signLinkValidTill: Date, redirectUrl: string): EmbeddedSigningLink
607
- ```
608
-
609
- Get sign link for Embedded Sign.
610
-
611
-
612
- ### Parameters
613
-
614
- |Name | Type | Description | Notes |
615
- | ------------- | ------------- | ------------- | ------------- |
616
- | **documentId** | **string**| | |
617
- | **signerEmail** | **string**| | [optional] |
618
- | **countryCode** | **string**| | [optional] |
619
- | **phoneNumber** | **string**| | [optional] |
620
- | **signLinkValidTill** | **Date**| | [optional] |
621
- | **redirectUrl** | **string**| | [optional] |
622
-
623
- ### Return type
624
-
625
- [**EmbeddedSigningLink**](../docs/EmbeddedSigningLink.md)
626
-
627
- ### Authorization
628
-
629
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
630
-
631
- ### HTTP request headers
632
-
633
- - **Content-Type**: Not defined
634
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
635
-
636
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
637
- [[Back to Model list]](../README.md#models)
638
- [[Back to README]](../README.md)
639
-
640
- ## `listDocuments()`
641
-
642
- ```typescript
643
- listDocuments(page: number, sentBy: Array<string>, recipients: Array<string>, transmitType: 'Sent' | 'Received' | 'Both', dateFilterType: 'SentBetween' | 'Expiring', pageSize: number, startDate: Date, status: Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>, endDate: Date, searchKey: string, labels: Array<string>, nextCursor: number, brandIds: Array<string>): DocumentRecords
644
- ```
645
-
646
- List user documents.
647
-
648
-
649
- ### Parameters
650
-
651
- |Name | Type | Description | Notes |
652
- | ------------- | ------------- | ------------- | ------------- |
653
- | **page** | **number**| Page index specified in get document list request. | [default to 1] |
654
- | **sentBy** | [**Array<string>**](../docs/string.md)| | [optional] |
655
- | **recipients** | [**Array<string>**](../docs/string.md)| | [optional] |
656
- | **transmitType** | **'Sent' | 'Received' | 'Both'**| | [optional] |
657
- | **dateFilterType** | **'SentBetween' | 'Expiring'**| Date Filter as SentBetween and ExpiresOn. | [optional] |
658
- | **pageSize** | **number**| Page size specified in get document list request. | [optional] [default to 10] |
659
- | **startDate** | **Date**| Start date of the document | [optional] |
660
- | **status** | [**Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>**](../docs/string.md)| Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. | [optional] |
661
- | **endDate** | **Date**| End date of the document | [optional] |
662
- | **searchKey** | **string**| Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., | [optional] |
663
- | **labels** | [**Array<string>**](../docs/string.md)| Labels of the document. | [optional] |
664
- | **nextCursor** | **number**| Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. | [optional] |
665
- | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the document. | [optional] |
666
-
667
- ### Return type
668
-
669
- [**DocumentRecords**](../docs/DocumentRecords.md)
670
-
671
- ### Authorization
672
-
673
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
674
-
675
- ### HTTP request headers
676
-
677
- - **Content-Type**: Not defined
678
- - **Accept**: `application/json`
679
-
680
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
681
- [[Back to Model list]](../README.md#models)
682
- [[Back to README]](../README.md)
683
-
684
- ## `prefillFields()`
685
-
686
- ```typescript
687
- prefillFields(documentId: string, prefillFieldRequest: PrefillFieldRequest)
688
- ```
689
-
690
- Updates the value (prefill) of the fields in the document.
691
-
692
-
693
- ### Parameters
694
-
695
- |Name | Type | Description | Notes |
696
- | ------------- | ------------- | ------------- | ------------- |
697
- | **documentId** | **string**| The DocumentId. | |
698
- | **prefillFieldRequest** | [**PrefillFieldRequest**](../docs/PrefillFieldRequest.md)| The prefill field request. | |
699
-
700
- ### Return type
701
-
702
- void (empty response body)
703
-
704
- ### Authorization
705
-
706
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
707
-
708
- ### HTTP request headers
709
-
710
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
711
- - **Accept**: `application/json`
712
-
713
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
714
- [[Back to Model list]](../README.md#models)
715
- [[Back to README]](../README.md)
716
-
717
- ## `remindDocument()`
718
-
719
- ```typescript
720
- remindDocument(documentId: string, receiverEmails: Array<string>, reminderMessage: ReminderMessage)
721
- ```
722
-
723
- Send reminder to pending signers.
724
-
725
-
726
- ### Parameters
727
-
728
- |Name | Type | Description | Notes |
729
- | ------------- | ------------- | ------------- | ------------- |
730
- | **documentId** | **string**| Document Id. | |
731
- | **receiverEmails** | [**Array<string>**](../docs/string.md)| Signer emails. | [optional] |
732
- | **reminderMessage** | [**ReminderMessage**](../docs/ReminderMessage.md)| Reminder Message for signers. | [optional] |
733
-
734
- ### Return type
735
-
736
- void (empty response body)
737
-
738
- ### Authorization
739
-
740
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
741
-
742
- ### HTTP request headers
743
-
744
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
745
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
746
-
747
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
748
- [[Back to Model list]](../README.md#models)
749
- [[Back to README]](../README.md)
750
-
751
- ## `removeAuthentication()`
752
-
753
- ```typescript
754
- removeAuthentication(documentId: string, removeAuthentication: RemoveAuthentication)
755
- ```
756
-
757
- Remove the access code for the given document signer.
758
-
759
-
760
- ### Parameters
761
-
762
- |Name | Type | Description | Notes |
763
- | ------------- | ------------- | ------------- | ------------- |
764
- | **documentId** | **string**| Document ID of the signature request | |
765
- | **removeAuthentication** | [**RemoveAuthentication**](../docs/RemoveAuthentication.md)| To remove access code. | [optional] |
766
-
767
- ### Return type
768
-
769
- void (empty response body)
770
-
771
- ### Authorization
772
-
773
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
774
-
775
- ### HTTP request headers
776
-
777
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
778
- - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
779
-
780
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
781
- [[Back to Model list]](../README.md#models)
782
- [[Back to README]](../README.md)
783
-
784
- ## `revokeDocument()`
785
-
786
- ```typescript
787
- revokeDocument(documentId: string, revokeDocument: RevokeDocument)
788
- ```
789
-
790
- Revoke the document.
791
-
792
-
793
- ### Parameters
794
-
795
- |Name | Type | Description | Notes |
796
- | ------------- | ------------- | ------------- | ------------- |
797
- | **documentId** | **string**| Document Id. | |
798
- | **revokeDocument** | [**RevokeDocument**](../docs/RevokeDocument.md)| RevokeDetails. | |
799
-
800
- ### Return type
801
-
802
- void (empty response body)
803
-
804
- ### Authorization
805
-
806
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
807
-
808
- ### HTTP request headers
809
-
810
- - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
811
- - **Accept**: `application/json`
812
-
813
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
814
- [[Back to Model list]](../README.md#models)
815
- [[Back to README]](../README.md)
816
-
817
- ## `sendDocument()`
818
-
819
- ```typescript
820
- sendDocument(sendForSign: SendForSign): DocumentCreated
821
- ```
822
-
823
- Sends the document for sign.
824
-
825
-
826
- ### Parameters
827
-
828
- |Name | Type | Description | Notes |
829
- | ------------- | ------------- | ------------- | ------------- |
830
- | **sendForSign** | [**SendForSign**](../docs/SendForSign.md)| The send for sign request body. | [optional] |
831
-
832
- ### Return type
833
-
834
- [**DocumentCreated**](../docs/DocumentCreated.md)
835
-
836
- ### Authorization
837
-
838
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
839
-
840
- ### HTTP request headers
841
-
842
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
843
- - **Accept**: `application/json`
844
-
845
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
846
- [[Back to Model list]](../README.md#models)
847
- [[Back to README]](../README.md)
848
-
849
- ## `teamDocuments()`
850
-
851
- ```typescript
852
- teamDocuments(page: number, userId: Array<string>, teamId: Array<string>, transmitType: 'Sent' | 'Received' | 'Both', dateFilterType: 'SentBetween' | 'Expiring', pageSize: number, startDate: Date, status: Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>, endDate: Date, searchKey: string, labels: Array<string>, nextCursor: number, brandIds: Array<string>): TeamDocumentRecords
853
- ```
854
-
855
- Get user Team documents.
856
-
857
-
858
- ### Parameters
859
-
860
- |Name | Type | Description | Notes |
861
- | ------------- | ------------- | ------------- | ------------- |
862
- | **page** | **number**| Page index specified in get document list request. | [default to 1] |
863
- | **userId** | [**Array<string>**](../docs/string.md)| UserId of the Team document. | [optional] |
864
- | **teamId** | [**Array<string>**](../docs/string.md)| TeamId of the Team document. | [optional] |
865
- | **transmitType** | **'Sent' | 'Received' | 'Both'**| Transmit type as Sent, Received and Both. | [optional] |
866
- | **dateFilterType** | **'SentBetween' | 'Expiring'**| Date Filter as SentBetween and Expiring. | [optional] |
867
- | **pageSize** | **number**| Page size specified in get document list request. | [optional] [default to 10] |
868
- | **startDate** | **Date**| Start date of the document | [optional] |
869
- | **status** | [**Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>**](../docs/string.md)| Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. | [optional] |
870
- | **endDate** | **Date**| End date of the document | [optional] |
871
- | **searchKey** | **string**| Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., | [optional] |
872
- | **labels** | [**Array<string>**](../docs/string.md)| Labels of the document. | [optional] |
873
- | **nextCursor** | **number**| Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. | [optional] |
874
- | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the document. | [optional] |
875
-
876
- ### Return type
877
-
878
- [**TeamDocumentRecords**](../docs/TeamDocumentRecords.md)
879
-
880
- ### Authorization
881
-
882
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
883
-
884
- ### HTTP request headers
885
-
886
- - **Content-Type**: Not defined
887
- - **Accept**: `application/json`
888
-
889
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
890
- [[Back to Model list]](../README.md#models)
891
- [[Back to README]](../README.md)
1
+ # DocumentApi
2
+
3
+ All URIs are relative to https://api.boldsign.com.
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------------- | ------------- | ------------- |
7
+ | [**addAuthentication()**](DocumentApi.md#addAuthentication) | **PATCH** /v1/document/addAuthentication | The add authentication to recipient. |
8
+ | [**addTag()**](DocumentApi.md#addTag) | **PATCH** /v1/document/addTags | Add the Tags in Documents. |
9
+ | [**behalfDocuments()**](DocumentApi.md#behalfDocuments) | **GET** /v1/document/behalfList | Gets the behalf documents. |
10
+ | [**cancelEditing()**](DocumentApi.md#cancelEditing) | **POST** /v1-beta/document/cancelEditing | Cancels editing for a document that is currently in edit-mode. |
11
+ | [**changeAccessCode()**](DocumentApi.md#changeAccessCode) | **PATCH** /v1/document/changeAccessCode | Changes the access code for the given document signer. |
12
+ | [**changeRecipient()**](DocumentApi.md#changeRecipient) | **PATCH** /v1/document/changeRecipient | Change recipient details of a document. |
13
+ | [**createEmbeddedDocumentCloneUrl()**](DocumentApi.md#createEmbeddedDocumentCloneUrl) | **POST** /v1-beta/document/createEmbeddedCloneUrl | Generates a URL to embeds Clone document process into your application. |
14
+ | [**createEmbeddedEditUrl()**](DocumentApi.md#createEmbeddedEditUrl) | **POST** /v1-beta/document/createEmbeddedEditUrl | Generates an embedded edit URL that allows the document editing process to be integrated into your application. |
15
+ | [**createEmbeddedRequestUrlDocument()**](DocumentApi.md#createEmbeddedRequestUrlDocument) | **POST** /v1/document/createEmbeddedRequestUrl | Generates a send URL which embeds document sending process into your application. |
16
+ | [**deleteDocument()**](DocumentApi.md#deleteDocument) | **DELETE** /v1/document/delete | Delete the document. |
17
+ | [**deleteTag()**](DocumentApi.md#deleteTag) | **DELETE** /v1/document/deleteTags | Delete the Tags in Documents. |
18
+ | [**downloadAttachment()**](DocumentApi.md#downloadAttachment) | **GET** /v1/document/downloadAttachment | Download the Attachment. |
19
+ | [**downloadAuditLog()**](DocumentApi.md#downloadAuditLog) | **GET** /v1/document/downloadAuditLog | Download the audit trail document. |
20
+ | [**downloadDocument()**](DocumentApi.md#downloadDocument) | **GET** /v1/document/download | Download the document. |
21
+ | [**draftSend()**](DocumentApi.md#draftSend) | **POST** /v1-beta/document/draftSend | Sends a draft-status document out for signature. |
22
+ | [**editDocument()**](DocumentApi.md#editDocument) | **PUT** /v1-beta/document/edit | Edit and updates an existing document. |
23
+ | [**extendExpiry()**](DocumentApi.md#extendExpiry) | **PATCH** /v1/document/extendExpiry | Extends the expiration date of the document. |
24
+ | [**getProperties()**](DocumentApi.md#getProperties) | **GET** /v1/document/properties | Get summary of the document. |
25
+ | [**getEmbeddedSignLink()**](DocumentApi.md#getEmbeddedSignLink) | **GET** /v1/document/getEmbeddedSignLink | Get sign link for Embedded Sign. |
26
+ | [**listDocuments()**](DocumentApi.md#listDocuments) | **GET** /v1/document/list | List user documents. |
27
+ | [**prefillFields()**](DocumentApi.md#prefillFields) | **PATCH** /v1/document/prefillFields | Updates the value (prefill) of the fields in the document. |
28
+ | [**remindDocument()**](DocumentApi.md#remindDocument) | **POST** /v1/document/remind | Send reminder to pending signers. |
29
+ | [**removeAuthentication()**](DocumentApi.md#removeAuthentication) | **PATCH** /v1/document/RemoveAuthentication | Remove the access code for the given document signer. |
30
+ | [**revokeDocument()**](DocumentApi.md#revokeDocument) | **POST** /v1/document/revoke | Revoke the document. |
31
+ | [**sendDocument()**](DocumentApi.md#sendDocument) | **POST** /v1/document/send | Sends the document for sign. |
32
+ | [**teamDocuments()**](DocumentApi.md#teamDocuments) | **GET** /v1/document/teamlist | Get user Team documents. |
33
+
34
+
35
+ ## `addAuthentication()`
36
+
37
+ ```typescript
38
+ addAuthentication(documentId: string, accessCodeDetail: AccessCodeDetail)
39
+ ```
40
+
41
+ The add authentication to recipient.
42
+
43
+
44
+ ### Parameters
45
+
46
+ |Name | Type | Description | Notes |
47
+ | ------------- | ------------- | ------------- | ------------- |
48
+ | **documentId** | **string**| | |
49
+ | **accessCodeDetail** | [**AccessCodeDetail**](../docs/AccessCodeDetail.md)| Access code details. | [optional] |
50
+
51
+ ### Return type
52
+
53
+ void (empty response body)
54
+
55
+ ### Authorization
56
+
57
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
58
+
59
+ ### HTTP request headers
60
+
61
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
62
+ - **Accept**: `application/json`
63
+
64
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
65
+ [[Back to Model list]](../README.md#models)
66
+ [[Back to README]](../README.md)
67
+
68
+ ## `addTag()`
69
+
70
+ ```typescript
71
+ addTag(documentTags: DocumentTags)
72
+ ```
73
+
74
+ Add the Tags in Documents.
75
+
76
+
77
+ ### Parameters
78
+
79
+ |Name | Type | Description | Notes |
80
+ | ------------- | ------------- | ------------- | ------------- |
81
+ | **documentTags** | [**DocumentTags**](../docs/DocumentTags.md)| Contains DocumentId and LabelNames for Adding Tags. | [optional] |
82
+
83
+ ### Return type
84
+
85
+ void (empty response body)
86
+
87
+ ### Authorization
88
+
89
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
90
+
91
+ ### HTTP request headers
92
+
93
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
94
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
95
+
96
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
97
+ [[Back to Model list]](../README.md#models)
98
+ [[Back to README]](../README.md)
99
+
100
+ ## `behalfDocuments()`
101
+
102
+ ```typescript
103
+ behalfDocuments(page: number, pageType: 'BehalfOfOthers' | 'BehalfOfMe', emailAddress: Array<string>, signers: Array<string>, pageSize: number, startDate: Date, status: Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>, endDate: Date, searchKey: string, labels: Array<string>, nextCursor: number, brandIds: Array<string>): BehalfDocumentRecords
104
+ ```
105
+
106
+ Gets the behalf documents.
107
+
108
+
109
+ ### Parameters
110
+
111
+ |Name | Type | Description | Notes |
112
+ | ------------- | ------------- | ------------- | ------------- |
113
+ | **page** | **number**| Page index specified in get document list request. | [default to 1] |
114
+ | **pageType** | **'BehalfOfOthers' | 'BehalfOfMe'**| The filter used to differentiate between documents sent on the user\&#39;s behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value. | [optional] |
115
+ | **emailAddress** | [**Array<string>**](../docs/string.md)| The sender identity\&#39;s email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address. | [optional] |
116
+ | **signers** | [**Array<string>**](../docs/string.md)| A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer\&#39;s email address matches one of the email addresses provided in this list | [optional] |
117
+ | **pageSize** | **number**| Page size specified in get document list request. | [optional] [default to 10] |
118
+ | **startDate** | **Date**| Start date of the document | [optional] |
119
+ | **status** | [**Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>**](../docs/string.md)| Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. | [optional] |
120
+ | **endDate** | **Date**| End date of the document | [optional] |
121
+ | **searchKey** | **string**| Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., | [optional] |
122
+ | **labels** | [**Array<string>**](../docs/string.md)| Labels of the document. | [optional] |
123
+ | **nextCursor** | **number**| Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. | [optional] |
124
+ | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the document. | [optional] |
125
+
126
+ ### Return type
127
+
128
+ [**BehalfDocumentRecords**](../docs/BehalfDocumentRecords.md)
129
+
130
+ ### Authorization
131
+
132
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
133
+
134
+ ### HTTP request headers
135
+
136
+ - **Content-Type**: Not defined
137
+ - **Accept**: `application/json`
138
+
139
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
140
+ [[Back to Model list]](../README.md#models)
141
+ [[Back to README]](../README.md)
142
+
143
+ ## `cancelEditing()`
144
+
145
+ ```typescript
146
+ cancelEditing(documentId: string, onBehalfOf: string)
147
+ ```
148
+
149
+ Cancels editing for a document that is currently in edit-mode.
150
+
151
+
152
+ ### Parameters
153
+
154
+ |Name | Type | Description | Notes |
155
+ | ------------- | ------------- | ------------- | ------------- |
156
+ | **documentId** | **string**| | |
157
+ | **onBehalfOf** | **string**| | [optional] |
158
+
159
+ ### Return type
160
+
161
+ void (empty response body)
162
+
163
+ ### Authorization
164
+
165
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
166
+
167
+ ### HTTP request headers
168
+
169
+ - **Content-Type**: Not defined
170
+ - **Accept**: `application/json`
171
+
172
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
173
+ [[Back to Model list]](../README.md#models)
174
+ [[Back to README]](../README.md)
175
+
176
+ ## `changeAccessCode()`
177
+
178
+ ```typescript
179
+ changeAccessCode(documentId: string, accessCodeDetails: AccessCodeDetails, emailId: string, zOrder: number)
180
+ ```
181
+
182
+ Changes the access code for the given document signer.
183
+
184
+
185
+ ### Parameters
186
+
187
+ |Name | Type | Description | Notes |
188
+ | ------------- | ------------- | ------------- | ------------- |
189
+ | **documentId** | **string**| | |
190
+ | **accessCodeDetails** | [**AccessCodeDetails**](../docs/AccessCodeDetails.md)| The new access code. | |
191
+ | **emailId** | **string**| | [optional] |
192
+ | **zOrder** | **number**| | [optional] |
193
+
194
+ ### Return type
195
+
196
+ void (empty response body)
197
+
198
+ ### Authorization
199
+
200
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
201
+
202
+ ### HTTP request headers
203
+
204
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
205
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
206
+
207
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
208
+ [[Back to Model list]](../README.md#models)
209
+ [[Back to README]](../README.md)
210
+
211
+ ## `changeRecipient()`
212
+
213
+ ```typescript
214
+ changeRecipient(documentId: string, changeRecipient: ChangeRecipient)
215
+ ```
216
+
217
+ Change recipient details of a document.
218
+
219
+
220
+ ### Parameters
221
+
222
+ |Name | Type | Description | Notes |
223
+ | ------------- | ------------- | ------------- | ------------- |
224
+ | **documentId** | **string**| | |
225
+ | **changeRecipient** | [**ChangeRecipient**](../docs/ChangeRecipient.md)| The new recipient details. | |
226
+
227
+ ### Return type
228
+
229
+ void (empty response body)
230
+
231
+ ### Authorization
232
+
233
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
234
+
235
+ ### HTTP request headers
236
+
237
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
238
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
239
+
240
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
241
+ [[Back to Model list]](../README.md#models)
242
+ [[Back to README]](../README.md)
243
+
244
+ ## `createEmbeddedDocumentCloneUrl()`
245
+
246
+ ```typescript
247
+ createEmbeddedDocumentCloneUrl(documentId: string, embeddedCloneDocumentJsonRequest: EmbeddedCloneDocumentJsonRequest): EmbeddedClonedDocument
248
+ ```
249
+
250
+ Generates a URL to embeds Clone document process into your application.
251
+
252
+
253
+ ### Parameters
254
+
255
+ |Name | Type | Description | Notes |
256
+ | ------------- | ------------- | ------------- | ------------- |
257
+ | **documentId** | **string**| The document id. | |
258
+ | **embeddedCloneDocumentJsonRequest** | [**EmbeddedCloneDocumentJsonRequest**](../docs/EmbeddedCloneDocumentJsonRequest.md)| The embedded clone document request body. | [optional] |
259
+
260
+ ### Return type
261
+
262
+ [**EmbeddedClonedDocument**](../docs/EmbeddedClonedDocument.md)
263
+
264
+ ### Authorization
265
+
266
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
267
+
268
+ ### HTTP request headers
269
+
270
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
271
+ - **Accept**: `application/json`
272
+
273
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
274
+ [[Back to Model list]](../README.md#models)
275
+ [[Back to README]](../README.md)
276
+
277
+ ## `createEmbeddedEditUrl()`
278
+
279
+ ```typescript
280
+ createEmbeddedEditUrl(documentId: string, embeddedDocumentEditJsonRequest: EmbeddedDocumentEditJsonRequest): EmbeddedDocumentEdited
281
+ ```
282
+
283
+ Generates an embedded edit URL that allows the document editing process to be integrated into your application.
284
+
285
+
286
+ ### Parameters
287
+
288
+ |Name | Type | Description | Notes |
289
+ | ------------- | ------------- | ------------- | ------------- |
290
+ | **documentId** | **string**| The document id. | |
291
+ | **embeddedDocumentEditJsonRequest** | [**EmbeddedDocumentEditJsonRequest**](../docs/EmbeddedDocumentEditJsonRequest.md)| The embedded edit document request body. | [optional] |
292
+
293
+ ### Return type
294
+
295
+ [**EmbeddedDocumentEdited**](../docs/EmbeddedDocumentEdited.md)
296
+
297
+ ### Authorization
298
+
299
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
300
+
301
+ ### HTTP request headers
302
+
303
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
304
+ - **Accept**: `application/json`
305
+
306
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
307
+ [[Back to Model list]](../README.md#models)
308
+ [[Back to README]](../README.md)
309
+
310
+ ## `createEmbeddedRequestUrlDocument()`
311
+
312
+ ```typescript
313
+ createEmbeddedRequestUrlDocument(embeddedDocumentRequest: EmbeddedDocumentRequest): EmbeddedSendCreated
314
+ ```
315
+
316
+ Generates a send URL which embeds document sending process into your application.
317
+
318
+
319
+ ### Parameters
320
+
321
+ |Name | Type | Description | Notes |
322
+ | ------------- | ------------- | ------------- | ------------- |
323
+ | **embeddedDocumentRequest** | [**EmbeddedDocumentRequest**](../docs/EmbeddedDocumentRequest.md)| The embedded send document request body. | [optional] |
324
+
325
+ ### Return type
326
+
327
+ [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
328
+
329
+ ### Authorization
330
+
331
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
332
+
333
+ ### HTTP request headers
334
+
335
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
336
+ - **Accept**: `application/json`
337
+
338
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
339
+ [[Back to Model list]](../README.md#models)
340
+ [[Back to README]](../README.md)
341
+
342
+ ## `deleteDocument()`
343
+
344
+ ```typescript
345
+ deleteDocument(documentId: string, deletePermanently: boolean)
346
+ ```
347
+
348
+ Delete the document.
349
+
350
+
351
+ ### Parameters
352
+
353
+ |Name | Type | Description | Notes |
354
+ | ------------- | ------------- | ------------- | ------------- |
355
+ | **documentId** | **string**| | |
356
+ | **deletePermanently** | **boolean**| | [optional] [default to false] |
357
+
358
+ ### Return type
359
+
360
+ void (empty response body)
361
+
362
+ ### Authorization
363
+
364
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
365
+
366
+ ### HTTP request headers
367
+
368
+ - **Content-Type**: Not defined
369
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
370
+
371
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
372
+ [[Back to Model list]](../README.md#models)
373
+ [[Back to README]](../README.md)
374
+
375
+ ## `deleteTag()`
376
+
377
+ ```typescript
378
+ deleteTag(documentTags: DocumentTags)
379
+ ```
380
+
381
+ Delete the Tags in Documents.
382
+
383
+
384
+ ### Parameters
385
+
386
+ |Name | Type | Description | Notes |
387
+ | ------------- | ------------- | ------------- | ------------- |
388
+ | **documentTags** | [**DocumentTags**](../docs/DocumentTags.md)| Contains DocumentId and LabelNames for Adding Tags. | [optional] |
389
+
390
+ ### Return type
391
+
392
+ void (empty response body)
393
+
394
+ ### Authorization
395
+
396
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
397
+
398
+ ### HTTP request headers
399
+
400
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
401
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
402
+
403
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
404
+ [[Back to Model list]](../README.md#models)
405
+ [[Back to README]](../README.md)
406
+
407
+ ## `downloadAttachment()`
408
+
409
+ ```typescript
410
+ downloadAttachment(documentId: string, attachmentId: string, onBehalfOf: string): Buffer
411
+ ```
412
+
413
+ Download the Attachment.
414
+
415
+
416
+ ### Parameters
417
+
418
+ |Name | Type | Description | Notes |
419
+ | ------------- | ------------- | ------------- | ------------- |
420
+ | **documentId** | **string**| | |
421
+ | **attachmentId** | **string**| | |
422
+ | **onBehalfOf** | **string**| | [optional] |
423
+
424
+ ### Return type
425
+
426
+ **Buffer**
427
+
428
+ ### Authorization
429
+
430
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
431
+
432
+ ### HTTP request headers
433
+
434
+ - **Content-Type**: Not defined
435
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
436
+
437
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
438
+ [[Back to Model list]](../README.md#models)
439
+ [[Back to README]](../README.md)
440
+
441
+ ## `downloadAuditLog()`
442
+
443
+ ```typescript
444
+ downloadAuditLog(documentId: string, onBehalfOf: string): Buffer
445
+ ```
446
+
447
+ Download the audit trail document.
448
+
449
+
450
+ ### Parameters
451
+
452
+ |Name | Type | Description | Notes |
453
+ | ------------- | ------------- | ------------- | ------------- |
454
+ | **documentId** | **string**| | |
455
+ | **onBehalfOf** | **string**| | [optional] |
456
+
457
+ ### Return type
458
+
459
+ **Buffer**
460
+
461
+ ### Authorization
462
+
463
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
464
+
465
+ ### HTTP request headers
466
+
467
+ - **Content-Type**: Not defined
468
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
469
+
470
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
471
+ [[Back to Model list]](../README.md#models)
472
+ [[Back to README]](../README.md)
473
+
474
+ ## `downloadDocument()`
475
+
476
+ ```typescript
477
+ downloadDocument(documentId: string, onBehalfOf: string): Buffer
478
+ ```
479
+
480
+ Download the document.
481
+
482
+
483
+ ### Parameters
484
+
485
+ |Name | Type | Description | Notes |
486
+ | ------------- | ------------- | ------------- | ------------- |
487
+ | **documentId** | **string**| | |
488
+ | **onBehalfOf** | **string**| | [optional] |
489
+
490
+ ### Return type
491
+
492
+ **Buffer**
493
+
494
+ ### Authorization
495
+
496
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
497
+
498
+ ### HTTP request headers
499
+
500
+ - **Content-Type**: Not defined
501
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
502
+
503
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
504
+ [[Back to Model list]](../README.md#models)
505
+ [[Back to README]](../README.md)
506
+
507
+ ## `draftSend()`
508
+
509
+ ```typescript
510
+ draftSend(documentId: string)
511
+ ```
512
+
513
+ Sends a draft-status document out for signature.
514
+
515
+
516
+ ### Parameters
517
+
518
+ |Name | Type | Description | Notes |
519
+ | ------------- | ------------- | ------------- | ------------- |
520
+ | **documentId** | **string**| | |
521
+
522
+ ### Return type
523
+
524
+ void (empty response body)
525
+
526
+ ### Authorization
527
+
528
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
529
+
530
+ ### HTTP request headers
531
+
532
+ - **Content-Type**: Not defined
533
+ - **Accept**: `application/json`
534
+
535
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
536
+ [[Back to Model list]](../README.md#models)
537
+ [[Back to README]](../README.md)
538
+
539
+ ## `editDocument()`
540
+
541
+ ```typescript
542
+ editDocument(documentId: string, editDocumentRequest: EditDocumentRequest): DocumentEdited
543
+ ```
544
+
545
+ Edit and updates an existing document.
546
+
547
+
548
+ ### Parameters
549
+
550
+ |Name | Type | Description | Notes |
551
+ | ------------- | ------------- | ------------- | ------------- |
552
+ | **documentId** | **string**| | |
553
+ | **editDocumentRequest** | [**EditDocumentRequest**](../docs/EditDocumentRequest.md)| Edit document JSON request. | [optional] |
554
+
555
+ ### Return type
556
+
557
+ [**DocumentEdited**](../docs/DocumentEdited.md)
558
+
559
+ ### Authorization
560
+
561
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
562
+
563
+ ### HTTP request headers
564
+
565
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
566
+ - **Accept**: `application/json`
567
+
568
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
569
+ [[Back to Model list]](../README.md#models)
570
+ [[Back to README]](../README.md)
571
+
572
+ ## `extendExpiry()`
573
+
574
+ ```typescript
575
+ extendExpiry(documentId: string, extendExpiry: ExtendExpiry)
576
+ ```
577
+
578
+ Extends the expiration date of the document.
579
+
580
+
581
+ ### Parameters
582
+
583
+ |Name | Type | Description | Notes |
584
+ | ------------- | ------------- | ------------- | ------------- |
585
+ | **documentId** | **string**| | |
586
+ | **extendExpiry** | [**ExtendExpiry**](../docs/ExtendExpiry.md)| The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. | [optional] |
587
+
588
+ ### Return type
589
+
590
+ void (empty response body)
591
+
592
+ ### Authorization
593
+
594
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
595
+
596
+ ### HTTP request headers
597
+
598
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
599
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
600
+
601
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
602
+ [[Back to Model list]](../README.md#models)
603
+ [[Back to README]](../README.md)
604
+
605
+ ## `getProperties()`
606
+
607
+ ```typescript
608
+ getProperties(documentId: string): DocumentProperties
609
+ ```
610
+
611
+ Get summary of the document.
612
+
613
+
614
+ ### Parameters
615
+
616
+ |Name | Type | Description | Notes |
617
+ | ------------- | ------------- | ------------- | ------------- |
618
+ | **documentId** | **string**| | |
619
+
620
+ ### Return type
621
+
622
+ [**DocumentProperties**](../docs/DocumentProperties.md)
623
+
624
+ ### Authorization
625
+
626
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
627
+
628
+ ### HTTP request headers
629
+
630
+ - **Content-Type**: Not defined
631
+ - **Accept**: `application/json`
632
+
633
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
634
+ [[Back to Model list]](../README.md#models)
635
+ [[Back to README]](../README.md)
636
+
637
+ ## `getEmbeddedSignLink()`
638
+
639
+ ```typescript
640
+ getEmbeddedSignLink(documentId: string, signerEmail: string, countryCode: string, phoneNumber: string, signLinkValidTill: Date, redirectUrl: string): EmbeddedSigningLink
641
+ ```
642
+
643
+ Get sign link for Embedded Sign.
644
+
645
+
646
+ ### Parameters
647
+
648
+ |Name | Type | Description | Notes |
649
+ | ------------- | ------------- | ------------- | ------------- |
650
+ | **documentId** | **string**| | |
651
+ | **signerEmail** | **string**| | [optional] |
652
+ | **countryCode** | **string**| | [optional] |
653
+ | **phoneNumber** | **string**| | [optional] |
654
+ | **signLinkValidTill** | **Date**| | [optional] |
655
+ | **redirectUrl** | **string**| | [optional] |
656
+
657
+ ### Return type
658
+
659
+ [**EmbeddedSigningLink**](../docs/EmbeddedSigningLink.md)
660
+
661
+ ### Authorization
662
+
663
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
664
+
665
+ ### HTTP request headers
666
+
667
+ - **Content-Type**: Not defined
668
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
669
+
670
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
671
+ [[Back to Model list]](../README.md#models)
672
+ [[Back to README]](../README.md)
673
+
674
+ ## `listDocuments()`
675
+
676
+ ```typescript
677
+ listDocuments(page: number, sentBy: Array<string>, recipients: Array<string>, transmitType: 'Sent' | 'Received' | 'Both', dateFilterType: 'SentBetween' | 'Expiring', pageSize: number, startDate: Date, status: Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>, endDate: Date, searchKey: string, labels: Array<string>, nextCursor: number, brandIds: Array<string>): DocumentRecords
678
+ ```
679
+
680
+ List user documents.
681
+
682
+
683
+ ### Parameters
684
+
685
+ |Name | Type | Description | Notes |
686
+ | ------------- | ------------- | ------------- | ------------- |
687
+ | **page** | **number**| Page index specified in get document list request. | [default to 1] |
688
+ | **sentBy** | [**Array<string>**](../docs/string.md)| | [optional] |
689
+ | **recipients** | [**Array<string>**](../docs/string.md)| | [optional] |
690
+ | **transmitType** | **'Sent' | 'Received' | 'Both'**| | [optional] |
691
+ | **dateFilterType** | **'SentBetween' | 'Expiring'**| Date Filter as SentBetween and ExpiresOn. | [optional] |
692
+ | **pageSize** | **number**| Page size specified in get document list request. | [optional] [default to 10] |
693
+ | **startDate** | **Date**| Start date of the document | [optional] |
694
+ | **status** | [**Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>**](../docs/string.md)| Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. | [optional] |
695
+ | **endDate** | **Date**| End date of the document | [optional] |
696
+ | **searchKey** | **string**| Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., | [optional] |
697
+ | **labels** | [**Array<string>**](../docs/string.md)| Labels of the document. | [optional] |
698
+ | **nextCursor** | **number**| Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. | [optional] |
699
+ | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the document. | [optional] |
700
+
701
+ ### Return type
702
+
703
+ [**DocumentRecords**](../docs/DocumentRecords.md)
704
+
705
+ ### Authorization
706
+
707
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
708
+
709
+ ### HTTP request headers
710
+
711
+ - **Content-Type**: Not defined
712
+ - **Accept**: `application/json`
713
+
714
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
715
+ [[Back to Model list]](../README.md#models)
716
+ [[Back to README]](../README.md)
717
+
718
+ ## `prefillFields()`
719
+
720
+ ```typescript
721
+ prefillFields(documentId: string, prefillFieldRequest: PrefillFieldRequest)
722
+ ```
723
+
724
+ Updates the value (prefill) of the fields in the document.
725
+
726
+
727
+ ### Parameters
728
+
729
+ |Name | Type | Description | Notes |
730
+ | ------------- | ------------- | ------------- | ------------- |
731
+ | **documentId** | **string**| | |
732
+ | **prefillFieldRequest** | [**PrefillFieldRequest**](../docs/PrefillFieldRequest.md)| The prefill field request. | |
733
+
734
+ ### Return type
735
+
736
+ void (empty response body)
737
+
738
+ ### Authorization
739
+
740
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
741
+
742
+ ### HTTP request headers
743
+
744
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
745
+ - **Accept**: `application/json`
746
+
747
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
748
+ [[Back to Model list]](../README.md#models)
749
+ [[Back to README]](../README.md)
750
+
751
+ ## `remindDocument()`
752
+
753
+ ```typescript
754
+ remindDocument(documentId: string, receiverEmails: Array<string>, reminderMessage: ReminderMessage)
755
+ ```
756
+
757
+ Send reminder to pending signers.
758
+
759
+
760
+ ### Parameters
761
+
762
+ |Name | Type | Description | Notes |
763
+ | ------------- | ------------- | ------------- | ------------- |
764
+ | **documentId** | **string**| | |
765
+ | **receiverEmails** | [**Array<string>**](../docs/string.md)| | [optional] |
766
+ | **reminderMessage** | [**ReminderMessage**](../docs/ReminderMessage.md)| Reminder Message for signers. | [optional] |
767
+
768
+ ### Return type
769
+
770
+ void (empty response body)
771
+
772
+ ### Authorization
773
+
774
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
775
+
776
+ ### HTTP request headers
777
+
778
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
779
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
780
+
781
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
782
+ [[Back to Model list]](../README.md#models)
783
+ [[Back to README]](../README.md)
784
+
785
+ ## `removeAuthentication()`
786
+
787
+ ```typescript
788
+ removeAuthentication(documentId: string, removeAuthentication: RemoveAuthentication)
789
+ ```
790
+
791
+ Remove the access code for the given document signer.
792
+
793
+
794
+ ### Parameters
795
+
796
+ |Name | Type | Description | Notes |
797
+ | ------------- | ------------- | ------------- | ------------- |
798
+ | **documentId** | **string**| Document ID of the signature request | |
799
+ | **removeAuthentication** | [**RemoveAuthentication**](../docs/RemoveAuthentication.md)| To remove access code. | [optional] |
800
+
801
+ ### Return type
802
+
803
+ void (empty response body)
804
+
805
+ ### Authorization
806
+
807
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
808
+
809
+ ### HTTP request headers
810
+
811
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
812
+ - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
813
+
814
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
815
+ [[Back to Model list]](../README.md#models)
816
+ [[Back to README]](../README.md)
817
+
818
+ ## `revokeDocument()`
819
+
820
+ ```typescript
821
+ revokeDocument(documentId: string, revokeDocument: RevokeDocument)
822
+ ```
823
+
824
+ Revoke the document.
825
+
826
+
827
+ ### Parameters
828
+
829
+ |Name | Type | Description | Notes |
830
+ | ------------- | ------------- | ------------- | ------------- |
831
+ | **documentId** | **string**| | |
832
+ | **revokeDocument** | [**RevokeDocument**](../docs/RevokeDocument.md)| RevokeDetails. | |
833
+
834
+ ### Return type
835
+
836
+ void (empty response body)
837
+
838
+ ### Authorization
839
+
840
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
841
+
842
+ ### HTTP request headers
843
+
844
+ - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
845
+ - **Accept**: `application/json`
846
+
847
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
848
+ [[Back to Model list]](../README.md#models)
849
+ [[Back to README]](../README.md)
850
+
851
+ ## `sendDocument()`
852
+
853
+ ```typescript
854
+ sendDocument(sendForSign: SendForSign): DocumentCreated
855
+ ```
856
+
857
+ Sends the document for sign.
858
+
859
+
860
+ ### Parameters
861
+
862
+ |Name | Type | Description | Notes |
863
+ | ------------- | ------------- | ------------- | ------------- |
864
+ | **sendForSign** | [**SendForSign**](../docs/SendForSign.md)| The send for sign request body. | [optional] |
865
+
866
+ ### Return type
867
+
868
+ [**DocumentCreated**](../docs/DocumentCreated.md)
869
+
870
+ ### Authorization
871
+
872
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
873
+
874
+ ### HTTP request headers
875
+
876
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
877
+ - **Accept**: `application/json`
878
+
879
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
880
+ [[Back to Model list]](../README.md#models)
881
+ [[Back to README]](../README.md)
882
+
883
+ ## `teamDocuments()`
884
+
885
+ ```typescript
886
+ teamDocuments(page: number, userId: Array<string>, teamId: Array<string>, transmitType: 'Sent' | 'Received' | 'Both', dateFilterType: 'SentBetween' | 'Expiring', pageSize: number, startDate: Date, status: Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>, endDate: Date, searchKey: string, labels: Array<string>, nextCursor: number, brandIds: Array<string>): TeamDocumentRecords
887
+ ```
888
+
889
+ Get user Team documents.
890
+
891
+
892
+ ### Parameters
893
+
894
+ |Name | Type | Description | Notes |
895
+ | ------------- | ------------- | ------------- | ------------- |
896
+ | **page** | **number**| Page index specified in get document list request. | [default to 1] |
897
+ | **userId** | [**Array<string>**](../docs/string.md)| UserId of the Team document. | [optional] |
898
+ | **teamId** | [**Array<string>**](../docs/string.md)| TeamId of the Team document. | [optional] |
899
+ | **transmitType** | **'Sent' | 'Received' | 'Both'**| Transmit type as Sent, Received and Both. | [optional] |
900
+ | **dateFilterType** | **'SentBetween' | 'Expiring'**| Date Filter as SentBetween and Expiring. | [optional] |
901
+ | **pageSize** | **number**| Page size specified in get document list request. | [optional] [default to 10] |
902
+ | **startDate** | **Date**| Start date of the document | [optional] |
903
+ | **status** | [**Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>**](../docs/string.md)| Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft. | [optional] |
904
+ | **endDate** | **Date**| End date of the document | [optional] |
905
+ | **searchKey** | **string**| Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc., | [optional] |
906
+ | **labels** | [**Array<string>**](../docs/string.md)| Labels of the document. | [optional] |
907
+ | **nextCursor** | **number**| Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records. | [optional] |
908
+ | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the document. | [optional] |
909
+
910
+ ### Return type
911
+
912
+ [**TeamDocumentRecords**](../docs/TeamDocumentRecords.md)
913
+
914
+ ### Authorization
915
+
916
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
917
+
918
+ ### HTTP request headers
919
+
920
+ - **Content-Type**: Not defined
921
+ - **Accept**: `application/json`
922
+
923
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
924
+ [[Back to Model list]](../README.md#models)
925
+ [[Back to README]](../README.md)