boldsign 1.0.3 → 1.0.4

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 (523) hide show
  1. package/.openapi-generator/FILES +157 -156
  2. package/.openapi-generator/VERSION +1 -1
  3. package/.openapi-generator-ignore +23 -23
  4. package/LICENSE +21 -21
  5. package/README.md +307 -306
  6. package/api/apis.ts +163 -163
  7. package/api/brandingApi.ts +1183 -1183
  8. package/api/contactsApi.ts +772 -772
  9. package/api/customFieldApi.ts +817 -817
  10. package/api/documentApi.ts +2953 -2953
  11. package/api/identityVerificationApi.ts +586 -586
  12. package/api/index.ts +36 -36
  13. package/api/planApi.ts +274 -274
  14. package/api/senderIdentitiesApi.ts +898 -898
  15. package/api/teamsApi.ts +661 -661
  16. package/api/templateApi.ts +1915 -1915
  17. package/api/userApi.ts +968 -968
  18. package/api.ts +3 -3
  19. package/boldsign-1.0.4.tgz +0 -0
  20. package/dist/api/apis.d.ts +1 -1
  21. package/dist/api/apis.js +1 -1
  22. package/dist/model/auditTrail.d.ts +3 -1
  23. package/dist/model/auditTrail.js +2 -0
  24. package/dist/model/auditTrail.js.map +1 -1
  25. package/dist/model/collaborationSettings.d.ts +17 -0
  26. package/dist/model/collaborationSettings.js +33 -0
  27. package/dist/model/collaborationSettings.js.map +1 -0
  28. package/dist/model/createTemplateRequest.d.ts +1 -1
  29. package/dist/model/createTemplateRequest.js +5 -5
  30. package/dist/model/createTemplateRequest.js.map +1 -1
  31. package/dist/model/documentFiles.d.ts +1 -0
  32. package/dist/model/documentFiles.js +5 -0
  33. package/dist/model/documentFiles.js.map +1 -1
  34. package/dist/model/documentFormFields.d.ts +3 -0
  35. package/dist/model/documentFormFields.js +10 -0
  36. package/dist/model/documentFormFields.js.map +1 -1
  37. package/dist/model/documentSigner.d.ts +1 -0
  38. package/dist/model/documentSigner.js +5 -0
  39. package/dist/model/documentSigner.js.map +1 -1
  40. package/dist/model/documentSignerDetails.d.ts +1 -0
  41. package/dist/model/documentSignerDetails.js +5 -0
  42. package/dist/model/documentSignerDetails.js.map +1 -1
  43. package/dist/model/embeddedCreateTemplateRequest.d.ts +1 -1
  44. package/dist/model/embeddedCreateTemplateRequest.js +5 -5
  45. package/dist/model/embeddedCreateTemplateRequest.js.map +1 -1
  46. package/dist/model/embeddedDocumentRequest.d.ts +1 -1
  47. package/dist/model/embeddedDocumentRequest.js +5 -5
  48. package/dist/model/embeddedDocumentRequest.js.map +1 -1
  49. package/dist/model/embeddedMergeTemplateFormRequest.d.ts +1 -1
  50. package/dist/model/embeddedMergeTemplateFormRequest.js +5 -5
  51. package/dist/model/embeddedMergeTemplateFormRequest.js.map +1 -1
  52. package/dist/model/embeddedSendTemplateFormRequest.d.ts +1 -1
  53. package/dist/model/embeddedSendTemplateFormRequest.js +5 -5
  54. package/dist/model/embeddedSendTemplateFormRequest.js.map +1 -1
  55. package/dist/model/formField.d.ts +2 -0
  56. package/dist/model/formField.js +5 -0
  57. package/dist/model/formField.js.map +1 -1
  58. package/dist/model/index.d.ts +2 -1
  59. package/dist/model/index.js +6 -3
  60. package/dist/model/index.js.map +1 -1
  61. package/dist/model/mergeAndSendForSignForm.d.ts +1 -1
  62. package/dist/model/mergeAndSendForSignForm.js +5 -5
  63. package/dist/model/mergeAndSendForSignForm.js.map +1 -1
  64. package/dist/model/sendForSign.d.ts +1 -1
  65. package/dist/model/sendForSign.js +5 -5
  66. package/dist/model/sendForSign.js.map +1 -1
  67. package/dist/model/sendForSignFromTemplateForm.d.ts +1 -1
  68. package/dist/model/sendForSignFromTemplateForm.js +5 -5
  69. package/dist/model/sendForSignFromTemplateForm.js.map +1 -1
  70. package/dist/model/templateFormFields.d.ts +2 -0
  71. package/dist/model/templateFormFields.js +5 -0
  72. package/dist/model/templateFormFields.js.map +1 -1
  73. package/dist/model/textTagDefinition.d.ts +2 -0
  74. package/dist/model/textTagDefinition.js +5 -0
  75. package/dist/model/textTagDefinition.js.map +1 -1
  76. package/dist/tests/config.d.ts +5 -0
  77. package/dist/tests/config.js +43 -0
  78. package/dist/tests/config.js.map +1 -0
  79. package/dist/tests/integration/BrandingApiTest.spec.d.ts +1 -0
  80. package/dist/tests/integration/BrandingApiTest.spec.js +310 -0
  81. package/dist/tests/integration/BrandingApiTest.spec.js.map +1 -0
  82. package/dist/tests/integration/ContactsApiTest.spec.d.ts +1 -0
  83. package/dist/tests/integration/ContactsApiTest.spec.js +249 -0
  84. package/dist/tests/integration/ContactsApiTest.spec.js.map +1 -0
  85. package/dist/tests/integration/CustomFieldApiTest.spec.d.ts +1 -0
  86. package/dist/tests/integration/CustomFieldApiTest.spec.js +289 -0
  87. package/dist/tests/integration/CustomFieldApiTest.spec.js.map +1 -0
  88. package/dist/tests/integration/DocumentApiTest.spec.d.ts +1 -0
  89. package/dist/tests/integration/DocumentApiTest.spec.js +1710 -0
  90. package/dist/tests/integration/DocumentApiTest.spec.js.map +1 -0
  91. package/dist/tests/integration/IdentityVerificationApiTest.spec.d.ts +1 -0
  92. package/dist/tests/integration/IdentityVerificationApiTest.spec.js +160 -0
  93. package/dist/tests/integration/IdentityVerificationApiTest.spec.js.map +1 -0
  94. package/dist/tests/integration/TemplateApiTest.spec.d.ts +1 -0
  95. package/dist/tests/integration/TemplateApiTest.spec.js +1518 -0
  96. package/dist/tests/integration/TemplateApiTest.spec.js.map +1 -0
  97. package/dist/tests/integration/planApiTest.spec.d.ts +1 -0
  98. package/dist/tests/integration/planApiTest.spec.js +41 -0
  99. package/dist/tests/integration/planApiTest.spec.js.map +1 -0
  100. package/dist/tests/integration/senderIdentity.spec.d.ts +1 -0
  101. package/dist/tests/integration/senderIdentity.spec.js +481 -0
  102. package/dist/tests/integration/senderIdentity.spec.js.map +1 -0
  103. package/dist/tests/integration/teamsApiTest.spec.d.ts +1 -0
  104. package/dist/tests/integration/teamsApiTest.spec.js +230 -0
  105. package/dist/tests/integration/teamsApiTest.spec.js.map +1 -0
  106. package/dist/tests/integration/usersApiTest.spec.d.ts +1 -0
  107. package/dist/tests/integration/usersApiTest.spec.js +290 -0
  108. package/dist/tests/integration/usersApiTest.spec.js.map +1 -0
  109. package/dist/tests/unit/brandingApi.spec.d.ts +1 -0
  110. package/dist/tests/unit/brandingApi.spec.js +174 -0
  111. package/dist/tests/unit/brandingApi.spec.js.map +1 -0
  112. package/dist/tests/unit/contactsApi.spec.d.ts +1 -0
  113. package/dist/tests/unit/contactsApi.spec.js +154 -0
  114. package/dist/tests/unit/contactsApi.spec.js.map +1 -0
  115. package/dist/tests/unit/customFieldApi.spec.d.ts +1 -0
  116. package/dist/tests/unit/customFieldApi.spec.js +140 -0
  117. package/dist/tests/unit/customFieldApi.spec.js.map +1 -0
  118. package/dist/tests/unit/documentApi.spec.d.ts +1 -0
  119. package/dist/tests/unit/documentApi.spec.js +476 -0
  120. package/dist/tests/unit/documentApi.spec.js.map +1 -0
  121. package/dist/tests/unit/planApi.spec.d.ts +1 -0
  122. package/dist/tests/unit/planApi.spec.js +69 -0
  123. package/dist/tests/unit/planApi.spec.js.map +1 -0
  124. package/dist/tests/unit/senderIdentitiesApi.spec.d.ts +1 -0
  125. package/dist/tests/unit/senderIdentitiesApi.spec.js +148 -0
  126. package/dist/tests/unit/senderIdentitiesApi.spec.js.map +1 -0
  127. package/dist/tests/unit/teamApi.spec.d.ts +1 -0
  128. package/dist/tests/unit/teamApi.spec.js +116 -0
  129. package/dist/tests/unit/teamApi.spec.js.map +1 -0
  130. package/dist/tests/unit/templateApi.spec.d.ts +1 -0
  131. package/dist/tests/unit/templateApi.spec.js +285 -0
  132. package/dist/tests/unit/templateApi.spec.js.map +1 -0
  133. package/dist/tests/unit/userApi.spec.d.ts +1 -0
  134. package/dist/tests/unit/userApi.spec.js +163 -0
  135. package/dist/tests/unit/userApi.spec.js.map +1 -0
  136. package/docs/AccessCodeDetail.md +19 -19
  137. package/docs/AccessCodeDetails.md +13 -13
  138. package/docs/Added.md +13 -13
  139. package/docs/Address.md +16 -16
  140. package/docs/AttachmentInfo.md +14 -14
  141. package/docs/AuditTrail.md +21 -21
  142. package/docs/AuthenticationSettings.md +11 -11
  143. package/docs/Base64File.md +12 -12
  144. package/docs/BehalfDocument.md +27 -27
  145. package/docs/BehalfDocumentRecords.md +12 -12
  146. package/docs/BehalfOf.md +12 -12
  147. package/docs/BillingViewModel.md +11 -11
  148. package/docs/BrandCreated.md +11 -11
  149. package/docs/BrandCustomFieldDetails.md +16 -16
  150. package/docs/BrandingApi.md +258 -258
  151. package/docs/BrandingMessage.md +11 -11
  152. package/docs/BrandingRecords.md +11 -11
  153. package/docs/ChangeRecipient.md +18 -18
  154. package/docs/CollaborationSettings.md +14 -0
  155. package/docs/ConditionalRule.md +13 -13
  156. package/docs/ContactCreated.md +12 -12
  157. package/docs/ContactDetails.md +15 -15
  158. package/docs/ContactPageDetails.md +13 -13
  159. package/docs/ContactsApi.md +176 -176
  160. package/docs/ContactsDetails.md +16 -16
  161. package/docs/ContactsList.md +12 -12
  162. package/docs/CreateContactResponse.md +11 -11
  163. package/docs/CreateSenderIdentityRequest.md +16 -16
  164. package/docs/CreateTeamRequest.md +11 -11
  165. package/docs/CreateTemplateRequest.md +35 -35
  166. package/docs/CreateUser.md +14 -14
  167. package/docs/CustomDomainSettings.md +12 -12
  168. package/docs/CustomFieldApi.md +174 -174
  169. package/docs/CustomFieldCollection.md +11 -11
  170. package/docs/CustomFieldMessage.md +12 -12
  171. package/docs/CustomFormField.md +43 -43
  172. package/docs/Date.md +13 -13
  173. package/docs/DeleteCustomFieldReply.md +11 -11
  174. package/docs/Document.md +26 -26
  175. package/docs/DocumentApi.md +756 -756
  176. package/docs/DocumentCC.md +11 -11
  177. package/docs/DocumentCcDetails.md +12 -12
  178. package/docs/DocumentCreated.md +11 -11
  179. package/docs/DocumentExpirySettings.md +16 -16
  180. package/docs/DocumentFiles.md +14 -13
  181. package/docs/DocumentFormFields.md +51 -49
  182. package/docs/DocumentInfo.md +14 -14
  183. package/docs/DocumentProperties.md +50 -50
  184. package/docs/DocumentReassign.md +13 -13
  185. package/docs/DocumentRecords.md +12 -12
  186. package/docs/DocumentSenderDetail.md +14 -14
  187. package/docs/DocumentSigner.md +32 -31
  188. package/docs/DocumentSignerDetails.md +38 -37
  189. package/docs/DocumentTags.md +12 -12
  190. package/docs/DownloadImageRequest.md +16 -16
  191. package/docs/EditSenderIdentityRequest.md +14 -14
  192. package/docs/EditTemplateRequest.md +29 -29
  193. package/docs/EditableDateFieldSettings.md +13 -13
  194. package/docs/EmbeddedCreateTemplateRequest.md +46 -46
  195. package/docs/EmbeddedCustomFieldCreated.md +11 -11
  196. package/docs/EmbeddedDocumentRequest.md +55 -55
  197. package/docs/EmbeddedFileDetails.md +16 -16
  198. package/docs/EmbeddedFileLink.md +11 -11
  199. package/docs/EmbeddedMergeTemplateFormRequest.md +56 -56
  200. package/docs/EmbeddedSendCreated.md +12 -12
  201. package/docs/EmbeddedSendTemplateFormRequest.md +53 -53
  202. package/docs/EmbeddedSigningLink.md +11 -11
  203. package/docs/EmbeddedTemplateCreated.md +12 -12
  204. package/docs/EmbeddedTemplateEditRequest.md +21 -21
  205. package/docs/EmbeddedTemplateEdited.md +11 -11
  206. package/docs/Error.md +12 -12
  207. package/docs/ErrorResult.md +11 -11
  208. package/docs/ExistingFormField.md +15 -15
  209. package/docs/ExtendExpiry.md +14 -14
  210. package/docs/FileInfo.md +14 -14
  211. package/docs/Font.md +18 -18
  212. package/docs/FormField.md +51 -50
  213. package/docs/FormGroup.md +15 -15
  214. package/docs/FormulaFieldSettings.md +12 -12
  215. package/docs/IdDocument.md +21 -21
  216. package/docs/IdReport.md +14 -14
  217. package/docs/IdVerification.md +18 -18
  218. package/docs/IdentityVerificationApi.md +109 -109
  219. package/docs/IdentityVerificationSettings.md +16 -16
  220. package/docs/ImageInfo.md +13 -13
  221. package/docs/MergeAndSendForSignForm.md +46 -46
  222. package/docs/ModificationDetails.md +12 -12
  223. package/docs/NotificationSettings.md +22 -22
  224. package/docs/PageDetails.md +16 -16
  225. package/docs/PhoneNumber.md +12 -12
  226. package/docs/PlanApi.md +38 -38
  227. package/docs/PrefillField.md +12 -12
  228. package/docs/PrefillFieldRequest.md +12 -12
  229. package/docs/ProblemDetails.md +15 -15
  230. package/docs/RecipientChangeLog.md +12 -12
  231. package/docs/RecipientNotificationSettings.md +22 -22
  232. package/docs/Rectangle.md +14 -14
  233. package/docs/ReminderMessage.md +13 -13
  234. package/docs/ReminderSettings.md +13 -13
  235. package/docs/RemoveAuthentication.md +14 -14
  236. package/docs/Removed.md +13 -13
  237. package/docs/RevokeDocument.md +12 -12
  238. package/docs/Role.md +33 -33
  239. package/docs/Roles.md +33 -33
  240. package/docs/SendForSign.md +45 -45
  241. package/docs/SendForSignFromTemplateForm.md +43 -43
  242. package/docs/SenderIdentitiesApi.md +209 -209
  243. package/docs/SenderIdentityCreated.md +11 -11
  244. package/docs/SenderIdentityList.md +12 -12
  245. package/docs/SenderIdentityViewModel.md +19 -19
  246. package/docs/SignerAuthenticationSettings.md +12 -12
  247. package/docs/Size.md +12 -12
  248. package/docs/TeamCreated.md +11 -11
  249. package/docs/TeamDocumentRecords.md +12 -12
  250. package/docs/TeamListResponse.md +12 -12
  251. package/docs/TeamPageDetails.md +12 -12
  252. package/docs/TeamResponse.md +15 -15
  253. package/docs/TeamUpdateRequest.md +12 -12
  254. package/docs/TeamUsers.md +16 -16
  255. package/docs/Teams.md +14 -14
  256. package/docs/TeamsApi.md +141 -141
  257. package/docs/Template.md +29 -29
  258. package/docs/TemplateApi.md +484 -484
  259. package/docs/TemplateCC.md +12 -12
  260. package/docs/TemplateCreated.md +11 -11
  261. package/docs/TemplateFormFields.md +51 -50
  262. package/docs/TemplateProperties.md +37 -37
  263. package/docs/TemplateRecords.md +12 -12
  264. package/docs/TemplateRole.md +28 -28
  265. package/docs/TemplateSenderDetail.md +12 -12
  266. package/docs/TemplateSenderDetails.md +13 -13
  267. package/docs/TemplateSharedTemplateDetail.md +12 -12
  268. package/docs/TemplateSignerDetails.md +27 -27
  269. package/docs/TemplateTag.md +14 -14
  270. package/docs/TextTagDefinition.md +41 -40
  271. package/docs/TextTagOffset.md +12 -12
  272. package/docs/UpdateUser.md +14 -14
  273. package/docs/UpdateUserMetaData.md +12 -12
  274. package/docs/UserApi.md +240 -240
  275. package/docs/UserPageDetails.md +12 -12
  276. package/docs/UserProperties.md +21 -21
  277. package/docs/UserRecords.md +12 -12
  278. package/docs/UsersDetails.md +21 -21
  279. package/docs/Validation.md +13 -13
  280. package/docs/VerificationDataRequest.md +15 -15
  281. package/docs/ViewBrandDetails.md +34 -34
  282. package/docs/ViewCustomFieldDetails.md +17 -17
  283. package/examples/DocumentProperties.ts +14 -14
  284. package/examples/brandCreate.ts +28 -28
  285. package/examples/brandDelete.ts +14 -14
  286. package/examples/brandGet.ts +14 -14
  287. package/examples/brandList.ts +13 -13
  288. package/examples/brandResetDefault.ts +14 -14
  289. package/examples/brandUpdate.ts +20 -20
  290. package/examples/contactCreate.ts +25 -25
  291. package/examples/contactDelete.ts +14 -14
  292. package/examples/contactGet.ts +14 -14
  293. package/examples/contactList.ts +15 -15
  294. package/examples/contactUpdate.ts +25 -25
  295. package/examples/customFieldCreate.ts +27 -27
  296. package/examples/customFieldDelete.ts +14 -14
  297. package/examples/customFieldEdit.ts +29 -29
  298. package/examples/customFieldEmbeddedCreateUrl.ts +18 -18
  299. package/examples/customFieldList.ts +14 -14
  300. package/examples/documentAddAuthentication.ts +19 -19
  301. package/examples/documentAddTags.ts +18 -18
  302. package/examples/documentChangeAccessCode.ts +19 -19
  303. package/examples/documentChangeRecipients.ts +21 -21
  304. package/examples/documentDelete.ts +15 -15
  305. package/examples/documentDeleteTags.ts +18 -18
  306. package/examples/documentDownload.ts +15 -15
  307. package/examples/documentDownloadAttachment.ts +16 -16
  308. package/examples/documentDownloadAuditTrial.ts +15 -15
  309. package/examples/documentEmbeddedRequestLink.ts +48 -48
  310. package/examples/documentEmbeddedSignLink.ts +22 -22
  311. package/examples/documentExtendExpiry.ts +19 -19
  312. package/examples/documentList.ts +18 -18
  313. package/examples/documentListBehalf.ts +14 -14
  314. package/examples/documentListTeam.ts +14 -14
  315. package/examples/documentPrefillFieldCheckBox.ts +22 -22
  316. package/examples/documentPrefillFieldDropDown.ts +22 -22
  317. package/examples/documentPrefillFieldEditableDate.ts +22 -22
  318. package/examples/documentPrefillFieldImage.ts +22 -22
  319. package/examples/documentPrefillFieldRadioButton.ts +22 -22
  320. package/examples/documentPrefillFieldTextBox.ts +22 -22
  321. package/examples/documentRemoveAuthentication.ts +18 -18
  322. package/examples/documentRevoke.ts +18 -18
  323. package/examples/documentSend.ts +46 -46
  324. package/examples/documentSendOnBehalf.ts +52 -52
  325. package/examples/documentSendReminder.ts +19 -19
  326. package/examples/embeddedManualVerification.ts +22 -22
  327. package/examples/identityVerificationImage.ts +23 -23
  328. package/examples/identityVerificationReport.ts +21 -21
  329. package/examples/listTemplate.ts +15 -15
  330. package/examples/plan.ts +13 -13
  331. package/examples/senderIdentityCreate.ts +20 -20
  332. package/examples/senderIdentityDelete.ts +14 -14
  333. package/examples/senderIdentityList.ts +15 -15
  334. package/examples/senderIdentityRerequest.ts +14 -14
  335. package/examples/senderIdentityResendInvitation.ts +14 -14
  336. package/examples/senderIdentityUpdate.ts +19 -19
  337. package/examples/teamCreate.ts +17 -17
  338. package/examples/teamGet.ts +14 -14
  339. package/examples/teamList.ts +15 -15
  340. package/examples/teamUpdate.ts +18 -18
  341. package/examples/templateAddTag.ts +19 -19
  342. package/examples/templateCreate.ts +28 -28
  343. package/examples/templateDelete.ts +14 -14
  344. package/examples/templateDeleteTag.ts +19 -19
  345. package/examples/templateDetails.ts +14 -14
  346. package/examples/templateDownload.ts +14 -14
  347. package/examples/templateEdit.ts +21 -21
  348. package/examples/templateEmbeddedCreate.ts +28 -28
  349. package/examples/templateEmbeddedEdit.ts +23 -23
  350. package/examples/templateEmbeddedRequestLink.ts +33 -33
  351. package/examples/templateMergerEmbeddedRequestUrl.ts +36 -36
  352. package/examples/templateSendDocument.ts +59 -59
  353. package/examples/templateSendDocumentUsingMultipleTemplate.ts +39 -39
  354. package/examples/userCreate.ts +19 -19
  355. package/examples/userGet.ts +14 -14
  356. package/examples/userInvitationCancel.ts +14 -14
  357. package/examples/userList.ts +15 -15
  358. package/examples/userResendInvitation.ts +14 -14
  359. package/examples/userUpdateRole.ts +18 -18
  360. package/git_push.sh +57 -57
  361. package/model/accessCodeDetail.ts +91 -91
  362. package/model/accessCodeDetails.ts +44 -44
  363. package/model/added.ts +43 -43
  364. package/model/address.ts +61 -61
  365. package/model/attachmentInfo.ts +49 -49
  366. package/model/auditTrail.ts +177 -175
  367. package/model/authenticationSettings.ts +40 -40
  368. package/model/base64File.ts +37 -37
  369. package/model/behalfDocument.ts +142 -142
  370. package/model/behalfDocumentRecords.ts +39 -39
  371. package/model/behalfOf.ts +37 -37
  372. package/model/billingViewModel.ts +31 -31
  373. package/model/brandCreated.ts +31 -31
  374. package/model/brandCustomFieldDetails.ts +62 -62
  375. package/model/brandingMessage.ts +31 -31
  376. package/model/brandingRecords.ts +32 -32
  377. package/model/changeRecipient.ts +74 -74
  378. package/model/collaborationSettings.ts +49 -0
  379. package/model/conditionalRule.ts +43 -43
  380. package/model/contactCreated.ts +37 -37
  381. package/model/contactDetails.ts +56 -56
  382. package/model/contactPageDetails.ts +43 -43
  383. package/model/contactsDetails.ts +62 -62
  384. package/model/contactsList.ts +39 -39
  385. package/model/createContactResponse.ts +32 -32
  386. package/model/createSenderIdentityRequest.ts +62 -62
  387. package/model/createTeamRequest.ts +31 -31
  388. package/model/createTemplateRequest.ts +181 -181
  389. package/model/createUser.ts +56 -56
  390. package/model/customDomainSettings.ts +37 -37
  391. package/model/customFieldCollection.ts +32 -32
  392. package/model/customFieldMessage.ts +37 -37
  393. package/model/customFormField.ts +275 -275
  394. package/model/deleteCustomFieldReply.ts +31 -31
  395. package/model/document.ts +135 -135
  396. package/model/documentCC.ts +31 -31
  397. package/model/documentCcDetails.ts +37 -37
  398. package/model/documentCreated.ts +31 -31
  399. package/model/documentExpirySettings.ts +69 -69
  400. package/model/documentFiles.ts +49 -43
  401. package/model/documentFormFields.ts +305 -292
  402. package/model/documentInfo.ts +90 -90
  403. package/model/documentProperties.ts +316 -316
  404. package/model/documentReassign.ts +43 -43
  405. package/model/documentRecords.ts +39 -39
  406. package/model/documentSenderDetail.ts +49 -49
  407. package/model/documentSigner.ts +221 -215
  408. package/model/documentSignerDetails.ts +265 -259
  409. package/model/documentTags.ts +37 -37
  410. package/model/downloadImageRequest.ts +61 -61
  411. package/model/editSenderIdentityRequest.ts +50 -50
  412. package/model/editTemplateRequest.ts +144 -144
  413. package/model/editableDateFieldSettings.ts +43 -43
  414. package/model/embeddedCreateTemplateRequest.ts +271 -271
  415. package/model/embeddedCustomFieldCreated.ts +31 -31
  416. package/model/embeddedDocumentRequest.ts +337 -337
  417. package/model/embeddedFileDetails.ts +61 -61
  418. package/model/embeddedFileLink.ts +31 -31
  419. package/model/embeddedMergeTemplateFormRequest.ts +343 -343
  420. package/model/embeddedSendCreated.ts +37 -37
  421. package/model/embeddedSendTemplateFormRequest.ts +324 -324
  422. package/model/embeddedSigningLink.ts +31 -31
  423. package/model/embeddedTemplateCreated.ts +37 -37
  424. package/model/embeddedTemplateEditRequest.ts +115 -115
  425. package/model/embeddedTemplateEdited.ts +31 -31
  426. package/model/errorResult.ts +31 -31
  427. package/model/existingFormField.ts +55 -55
  428. package/model/extendExpiry.ts +49 -49
  429. package/model/fileInfo.ts +49 -49
  430. package/model/font.ts +89 -89
  431. package/model/formField.ts +327 -320
  432. package/model/formGroup.ts +63 -63
  433. package/model/formulaFieldSettings.ts +37 -37
  434. package/model/idDocument.ts +93 -93
  435. package/model/idReport.ts +50 -50
  436. package/model/idVerification.ts +73 -73
  437. package/model/identityVerificationSettings.ts +75 -75
  438. package/model/imageInfo.ts +43 -43
  439. package/model/index.ts +546 -543
  440. package/model/mergeAndSendForSignForm.ts +261 -261
  441. package/model/modelDate.ts +43 -43
  442. package/model/modelError.ts +37 -37
  443. package/model/models.ts +244 -244
  444. package/model/modificationDetails.ts +37 -37
  445. package/model/notificationSettings.ts +97 -97
  446. package/model/pageDetails.ts +61 -61
  447. package/model/phoneNumber.ts +37 -37
  448. package/model/prefillField.ts +37 -37
  449. package/model/prefillFieldRequest.ts +38 -38
  450. package/model/problemDetails.ts +55 -55
  451. package/model/recipientChangeLog.ts +39 -39
  452. package/model/recipientNotificationSettings.ts +97 -97
  453. package/model/rectangle.ts +49 -49
  454. package/model/reminderMessage.ts +44 -44
  455. package/model/reminderSettings.ts +43 -43
  456. package/model/removeAuthentication.ts +50 -50
  457. package/model/removed.ts +43 -43
  458. package/model/revokeDocument.ts +37 -37
  459. package/model/role.ts +229 -229
  460. package/model/roles.ts +225 -225
  461. package/model/sendForSign.ts +255 -255
  462. package/model/sendForSignFromTemplateForm.ts +242 -242
  463. package/model/senderIdentityCreated.ts +31 -31
  464. package/model/senderIdentityList.ts +39 -39
  465. package/model/senderIdentityViewModel.ts +80 -80
  466. package/model/signerAuthenticationSettings.ts +37 -37
  467. package/model/size.ts +37 -37
  468. package/model/teamCreated.ts +31 -31
  469. package/model/teamDocumentRecords.ts +39 -39
  470. package/model/teamListResponse.ts +39 -39
  471. package/model/teamPageDetails.ts +37 -37
  472. package/model/teamResponse.ts +56 -56
  473. package/model/teamUpdateRequest.ts +37 -37
  474. package/model/teamUsers.ts +73 -73
  475. package/model/teams.ts +49 -49
  476. package/model/template.ts +159 -159
  477. package/model/templateCC.ts +37 -37
  478. package/model/templateCreated.ts +31 -31
  479. package/model/templateFormFields.ts +304 -297
  480. package/model/templateProperties.ts +202 -202
  481. package/model/templateRecords.ts +39 -39
  482. package/model/templateRole.ts +195 -195
  483. package/model/templateSenderDetail.ts +37 -37
  484. package/model/templateSenderDetails.ts +43 -43
  485. package/model/templateSharedTemplateDetail.ts +43 -43
  486. package/model/templateSignerDetails.ts +160 -160
  487. package/model/templateTag.ts +49 -49
  488. package/model/textTagDefinition.ts +255 -248
  489. package/model/textTagOffset.ts +37 -37
  490. package/model/updateUser.ts +60 -60
  491. package/model/updateUserMetaData.ts +37 -37
  492. package/model/userPageDetails.ts +37 -37
  493. package/model/userProperties.ts +91 -91
  494. package/model/userRecords.ts +39 -39
  495. package/model/usersDetails.ts +91 -91
  496. package/model/validation.ts +52 -52
  497. package/model/verificationDataRequest.ts +55 -55
  498. package/model/viewBrandDetails.ts +177 -177
  499. package/model/viewCustomFieldDetails.ts +68 -68
  500. package/package.json +52 -52
  501. package/tests/config.ts +20 -0
  502. package/tests/documents/agreement.pdf +0 -0
  503. package/tests/documents/logo.jpg +0 -0
  504. package/tests/integration/BrandingApiTest.spec.ts +254 -0
  505. package/tests/integration/ContactsApiTest.spec.ts +222 -0
  506. package/tests/integration/CustomFieldApiTest.spec.ts +231 -0
  507. package/tests/integration/DocumentApiTest.spec.ts +1624 -0
  508. package/tests/integration/IdentityVerificationApiTest.spec.ts +114 -0
  509. package/tests/integration/TemplateApiTest.spec.ts +1420 -0
  510. package/tests/integration/planApiTest.spec.ts +26 -0
  511. package/tests/integration/senderIdentity.spec.ts +397 -0
  512. package/tests/integration/teamsApiTest.spec.ts +226 -0
  513. package/tests/integration/usersApiTest.spec.ts +251 -0
  514. package/tests/unit/brandingApi.spec.ts +163 -0
  515. package/tests/unit/contactsApi.spec.ts +143 -0
  516. package/tests/unit/customFieldApi.spec.ts +123 -0
  517. package/tests/unit/documentApi.spec.ts +545 -0
  518. package/tests/unit/planApi.spec.ts +34 -0
  519. package/tests/unit/senderIdentitiesApi.spec.ts +148 -0
  520. package/tests/unit/teamApi.spec.ts +94 -0
  521. package/tests/unit/templateApi.spec.ts +307 -0
  522. package/tests/unit/userApi.spec.ts +162 -0
  523. package/tsconfig.json +24 -24
package/docs/TemplateApi.md CHANGED
@@ -1,484 +1,484 @@
1
- # TemplateApi
2
-
3
- All URIs are relative to https://api.boldsign.com.
4
-
5
- | Method | HTTP request | Description |
6
- | ------------- | ------------- | ------------- |
7
- | [**addTag()**](TemplateApi.md#addTag) | **PATCH** /v1/template/addTags | Add the Tags in Templates. |
8
- | [**createEmbeddedRequestUrlTemplate()**](TemplateApi.md#createEmbeddedRequestUrlTemplate) | **POST** /v1/template/createEmbeddedRequestUrl | Generates a send URL using a template which embeds document sending process into your application. |
9
- | [**createEmbeddedTemplateUrl()**](TemplateApi.md#createEmbeddedTemplateUrl) | **POST** /v1/template/createEmbeddedTemplateUrl | Generates a create URL to embeds template create process into your application. |
10
- | [**createTemplate()**](TemplateApi.md#createTemplate) | **POST** /v1/template/create | Creates a new template. |
11
- | [**deleteTemplate()**](TemplateApi.md#deleteTemplate) | **DELETE** /v1/template/delete | Deletes a template. |
12
- | [**deleteTag()**](TemplateApi.md#deleteTag) | **DELETE** /v1/template/deleteTags | Delete the Tags in Templates. |
13
- | [**download()**](TemplateApi.md#download) | **GET** /v1/template/download | Download the template. |
14
- | [**editTemplate()**](TemplateApi.md#editTemplate) | **PUT** /v1/template/edit | Edit and updates an existing template. |
15
- | [**getEmbeddedTemplateEditUrl()**](TemplateApi.md#getEmbeddedTemplateEditUrl) | **POST** /v1/template/getEmbeddedTemplateEditUrl | Generates a edit URL to embeds template edit process into your application. |
16
- | [**getProperties()**](TemplateApi.md#getProperties) | **GET** /v1/template/properties | Get summary of the template. |
17
- | [**listTemplates()**](TemplateApi.md#listTemplates) | **GET** /v1/template/list | List all the templates. |
18
- | [**mergeAndSend()**](TemplateApi.md#mergeAndSend) | **POST** /v1/template/mergeAndSend | Send the document by merging multiple templates. |
19
- | [**mergeCreateEmbeddedRequestUrlTemplate()**](TemplateApi.md#mergeCreateEmbeddedRequestUrlTemplate) | **POST** /v1/template/mergeCreateEmbeddedRequestUrl | Generates a merge request URL using a template that combines document merging and sending processes into your application. |
20
- | [**sendUsingTemplate()**](TemplateApi.md#sendUsingTemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
21
-
22
-
23
- ## `addTag()`
24
-
25
- ```typescript
26
- addTag(templateTag: TemplateTag)
27
- ```
28
-
29
- Add the Tags in Templates.
30
-
31
-
32
- ### Parameters
33
-
34
- |Name | Type | Description | Notes |
35
- | ------------- | ------------- | ------------- | ------------- |
36
- | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| ContainsTemplateId and Label Names for AddingTags. | [optional] |
37
-
38
- ### Return type
39
-
40
- void (empty response body)
41
-
42
- ### Authorization
43
-
44
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
45
-
46
- ### HTTP request headers
47
-
48
- - **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`
49
- - **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`
50
-
51
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
52
- [[Back to Model list]](../README.md#models)
53
- [[Back to README]](../README.md)
54
-
55
- ## `createEmbeddedRequestUrlTemplate()`
56
-
57
- ```typescript
58
- createEmbeddedRequestUrlTemplate(templateId: string, embeddedSendTemplateFormRequest: EmbeddedSendTemplateFormRequest): EmbeddedSendCreated
59
- ```
60
-
61
- Generates a send URL using a template which embeds document sending process into your application.
62
-
63
-
64
- ### Parameters
65
-
66
- |Name | Type | Description | Notes |
67
- | ------------- | ------------- | ------------- | ------------- |
68
- | **templateId** | **string**| The template id. | |
69
- | **embeddedSendTemplateFormRequest** | [**EmbeddedSendTemplateFormRequest**](../docs/EmbeddedSendTemplateFormRequest.md)| Embedded send template json request. | [optional] |
70
-
71
- ### Return type
72
-
73
- [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
74
-
75
- ### Authorization
76
-
77
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
78
-
79
- ### HTTP request headers
80
-
81
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
82
- - **Accept**: `application/json`
83
-
84
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
85
- [[Back to Model list]](../README.md#models)
86
- [[Back to README]](../README.md)
87
-
88
- ## `createEmbeddedTemplateUrl()`
89
-
90
- ```typescript
91
- createEmbeddedTemplateUrl(embeddedCreateTemplateRequest: EmbeddedCreateTemplateRequest): EmbeddedTemplateCreated
92
- ```
93
-
94
- Generates a create URL to embeds template create process into your application.
95
-
96
-
97
- ### Parameters
98
-
99
- |Name | Type | Description | Notes |
100
- | ------------- | ------------- | ------------- | ------------- |
101
- | **embeddedCreateTemplateRequest** | [**EmbeddedCreateTemplateRequest**](../docs/EmbeddedCreateTemplateRequest.md)| The create embedded template request body. | [optional] |
102
-
103
- ### Return type
104
-
105
- [**EmbeddedTemplateCreated**](../docs/EmbeddedTemplateCreated.md)
106
-
107
- ### Authorization
108
-
109
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
110
-
111
- ### HTTP request headers
112
-
113
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
114
- - **Accept**: `application/json`
115
-
116
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
117
- [[Back to Model list]](../README.md#models)
118
- [[Back to README]](../README.md)
119
-
120
- ## `createTemplate()`
121
-
122
- ```typescript
123
- createTemplate(createTemplateRequest: CreateTemplateRequest): TemplateCreated
124
- ```
125
-
126
- Creates a new template.
127
-
128
-
129
- ### Parameters
130
-
131
- |Name | Type | Description | Notes |
132
- | ------------- | ------------- | ------------- | ------------- |
133
- | **createTemplateRequest** | [**CreateTemplateRequest**](../docs/CreateTemplateRequest.md)| The create template request body. | [optional] |
134
-
135
- ### Return type
136
-
137
- [**TemplateCreated**](../docs/TemplateCreated.md)
138
-
139
- ### Authorization
140
-
141
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
142
-
143
- ### HTTP request headers
144
-
145
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
146
- - **Accept**: `application/json`
147
-
148
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
149
- [[Back to Model list]](../README.md#models)
150
- [[Back to README]](../README.md)
151
-
152
- ## `deleteTemplate()`
153
-
154
- ```typescript
155
- deleteTemplate(templateId: string, onBehalfOf: string)
156
- ```
157
-
158
- Deletes a template.
159
-
160
-
161
- ### Parameters
162
-
163
- |Name | Type | Description | Notes |
164
- | ------------- | ------------- | ------------- | ------------- |
165
- | **templateId** | **string**| The template id. | |
166
- | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
167
-
168
- ### Return type
169
-
170
- void (empty response body)
171
-
172
- ### Authorization
173
-
174
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
175
-
176
- ### HTTP request headers
177
-
178
- - **Content-Type**: Not defined
179
- - **Accept**: `application/json`
180
-
181
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
182
- [[Back to Model list]](../README.md#models)
183
- [[Back to README]](../README.md)
184
-
185
- ## `deleteTag()`
186
-
187
- ```typescript
188
- deleteTag(templateTag: TemplateTag)
189
- ```
190
-
191
- Delete the Tags in Templates.
192
-
193
-
194
- ### Parameters
195
-
196
- |Name | Type | Description | Notes |
197
- | ------------- | ------------- | ------------- | ------------- |
198
- | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| Contains TemplateId and LabelNames for Adding Tags. | [optional] |
199
-
200
- ### Return type
201
-
202
- void (empty response body)
203
-
204
- ### Authorization
205
-
206
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
207
-
208
- ### HTTP request headers
209
-
210
- - **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`
211
- - **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`
212
-
213
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
214
- [[Back to Model list]](../README.md#models)
215
- [[Back to README]](../README.md)
216
-
217
- ## `download()`
218
-
219
- ```typescript
220
- download(templateId: string, onBehalfOf: string): Buffer
221
- ```
222
-
223
- Download the template.
224
-
225
-
226
- ### Parameters
227
-
228
- |Name | Type | Description | Notes |
229
- | ------------- | ------------- | ------------- | ------------- |
230
- | **templateId** | **string**| Template Id. | |
231
- | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
232
-
233
- ### Return type
234
-
235
- **Buffer**
236
-
237
- ### Authorization
238
-
239
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
240
-
241
- ### HTTP request headers
242
-
243
- - **Content-Type**: Not defined
244
- - **Accept**: `application/json`
245
-
246
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
247
- [[Back to Model list]](../README.md#models)
248
- [[Back to README]](../README.md)
249
-
250
- ## `editTemplate()`
251
-
252
- ```typescript
253
- editTemplate(templateId: string, editTemplateRequest: EditTemplateRequest)
254
- ```
255
-
256
- Edit and updates an existing template.
257
-
258
-
259
- ### Parameters
260
-
261
- |Name | Type | Description | Notes |
262
- | ------------- | ------------- | ------------- | ------------- |
263
- | **templateId** | **string**| The template id. | |
264
- | **editTemplateRequest** | [**EditTemplateRequest**](../docs/EditTemplateRequest.md)| The edit template request body. | |
265
-
266
- ### Return type
267
-
268
- void (empty response body)
269
-
270
- ### Authorization
271
-
272
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
273
-
274
- ### HTTP request headers
275
-
276
- - **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`
277
- - **Accept**: `application/json`
278
-
279
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
280
- [[Back to Model list]](../README.md#models)
281
- [[Back to README]](../README.md)
282
-
283
- ## `getEmbeddedTemplateEditUrl()`
284
-
285
- ```typescript
286
- getEmbeddedTemplateEditUrl(templateId: string, embeddedTemplateEditRequest: EmbeddedTemplateEditRequest): EmbeddedTemplateEdited
287
- ```
288
-
289
- Generates a edit URL to embeds template edit process into your application.
290
-
291
-
292
- ### Parameters
293
-
294
- |Name | Type | Description | Notes |
295
- | ------------- | ------------- | ------------- | ------------- |
296
- | **templateId** | **string**| The template id. | |
297
- | **embeddedTemplateEditRequest** | [**EmbeddedTemplateEditRequest**](../docs/EmbeddedTemplateEditRequest.md)| The embedded edit template request body. | [optional] |
298
-
299
- ### Return type
300
-
301
- [**EmbeddedTemplateEdited**](../docs/EmbeddedTemplateEdited.md)
302
-
303
- ### Authorization
304
-
305
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
306
-
307
- ### HTTP request headers
308
-
309
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
310
- - **Accept**: `application/json`
311
-
312
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
313
- [[Back to Model list]](../README.md#models)
314
- [[Back to README]](../README.md)
315
-
316
- ## `getProperties()`
317
-
318
- ```typescript
319
- getProperties(templateId: string): TemplateProperties
320
- ```
321
-
322
- Get summary of the template.
323
-
324
-
325
- ### Parameters
326
-
327
- |Name | Type | Description | Notes |
328
- | ------------- | ------------- | ------------- | ------------- |
329
- | **templateId** | **string**| Template Id. | |
330
-
331
- ### Return type
332
-
333
- [**TemplateProperties**](../docs/TemplateProperties.md)
334
-
335
- ### Authorization
336
-
337
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
338
-
339
- ### HTTP request headers
340
-
341
- - **Content-Type**: Not defined
342
- - **Accept**: `application/json`
343
-
344
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
345
- [[Back to Model list]](../README.md#models)
346
- [[Back to README]](../README.md)
347
-
348
- ## `listTemplates()`
349
-
350
- ```typescript
351
- listTemplates(page: number, templateType: 'mytemplates' | 'sharedtemplate' | 'all', pageSize: number, searchKey: string, onBehalfOf: Array<string>, createdBy: Array<string>, templateLabels: Array<string>, startDate: Date, endDate: Date, brandIds: Array<string>): TemplateRecords
352
- ```
353
-
354
- List all the templates.
355
-
356
-
357
- ### Parameters
358
-
359
- |Name | Type | Description | Notes |
360
- | ------------- | ------------- | ------------- | ------------- |
361
- | **page** | **number**| | [default to 1] |
362
- | **templateType** | **'mytemplates' | 'sharedtemplate' | 'all'**| | [optional] |
363
- | **pageSize** | **number**| | [optional] [default to 10] |
364
- | **searchKey** | **string**| | [optional] |
365
- | **onBehalfOf** | [**Array<string>**](../docs/string.md)| The sender identity\&#39;s email used to filter the templates returned in the API. The API will return templates that were sent on behalf of the specified email address. | [optional] |
366
- | **createdBy** | [**Array<string>**](../docs/string.md)| The templates can be listed by the creator of the template. | [optional] |
367
- | **templateLabels** | [**Array<string>**](../docs/string.md)| Labels of the template. | [optional] |
368
- | **startDate** | **Date**| Start date of the template | [optional] |
369
- | **endDate** | **Date**| End date of the template | [optional] |
370
- | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the template. | [optional] |
371
-
372
- ### Return type
373
-
374
- [**TemplateRecords**](../docs/TemplateRecords.md)
375
-
376
- ### Authorization
377
-
378
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
379
-
380
- ### HTTP request headers
381
-
382
- - **Content-Type**: Not defined
383
- - **Accept**: `application/json`
384
-
385
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
386
- [[Back to Model list]](../README.md#models)
387
- [[Back to README]](../README.md)
388
-
389
- ## `mergeAndSend()`
390
-
391
- ```typescript
392
- mergeAndSend(mergeAndSendForSignForm: MergeAndSendForSignForm): DocumentCreated
393
- ```
394
-
395
- Send the document by merging multiple templates.
396
-
397
-
398
- ### Parameters
399
-
400
- |Name | Type | Description | Notes |
401
- | ------------- | ------------- | ------------- | ------------- |
402
- | **mergeAndSendForSignForm** | [**MergeAndSendForSignForm**](../docs/MergeAndSendForSignForm.md)| The merge and send details as JSON. | [optional] |
403
-
404
- ### Return type
405
-
406
- [**DocumentCreated**](../docs/DocumentCreated.md)
407
-
408
- ### Authorization
409
-
410
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
411
-
412
- ### HTTP request headers
413
-
414
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
415
- - **Accept**: `application/json`
416
-
417
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
418
- [[Back to Model list]](../README.md#models)
419
- [[Back to README]](../README.md)
420
-
421
- ## `mergeCreateEmbeddedRequestUrlTemplate()`
422
-
423
- ```typescript
424
- mergeCreateEmbeddedRequestUrlTemplate(embeddedMergeTemplateFormRequest: EmbeddedMergeTemplateFormRequest): EmbeddedSendCreated
425
- ```
426
-
427
- Generates a merge request URL using a template that combines document merging and sending processes into your application.
428
-
429
-
430
- ### Parameters
431
-
432
- |Name | Type | Description | Notes |
433
- | ------------- | ------------- | ------------- | ------------- |
434
- | **embeddedMergeTemplateFormRequest** | [**EmbeddedMergeTemplateFormRequest**](../docs/EmbeddedMergeTemplateFormRequest.md)| Embedded merge and send template json request. | [optional] |
435
-
436
- ### Return type
437
-
438
- [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
439
-
440
- ### Authorization
441
-
442
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
443
-
444
- ### HTTP request headers
445
-
446
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
447
- - **Accept**: `application/json`
448
-
449
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
450
- [[Back to Model list]](../README.md#models)
451
- [[Back to README]](../README.md)
452
-
453
- ## `sendUsingTemplate()`
454
-
455
- ```typescript
456
- sendUsingTemplate(templateId: string, sendForSignFromTemplateForm: SendForSignFromTemplateForm): DocumentCreated
457
- ```
458
-
459
- Send a document for signature using a Template.
460
-
461
-
462
- ### Parameters
463
-
464
- |Name | Type | Description | Notes |
465
- | ------------- | ------------- | ------------- | ------------- |
466
- | **templateId** | **string**| The template id. | |
467
- | **sendForSignFromTemplateForm** | [**SendForSignFromTemplateForm**](../docs/SendForSignFromTemplateForm.md)| The send template details as JSON. | [optional] |
468
-
469
- ### Return type
470
-
471
- [**DocumentCreated**](../docs/DocumentCreated.md)
472
-
473
- ### Authorization
474
-
475
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
476
-
477
- ### HTTP request headers
478
-
479
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
480
- - **Accept**: `application/json`
481
-
482
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
483
- [[Back to Model list]](../README.md#models)
484
- [[Back to README]](../README.md)
1
+ # TemplateApi
2
+
3
+ All URIs are relative to https://api.boldsign.com.
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------------- | ------------- | ------------- |
7
+ | [**addTag()**](TemplateApi.md#addTag) | **PATCH** /v1/template/addTags | Add the Tags in Templates. |
8
+ | [**createEmbeddedRequestUrlTemplate()**](TemplateApi.md#createEmbeddedRequestUrlTemplate) | **POST** /v1/template/createEmbeddedRequestUrl | Generates a send URL using a template which embeds document sending process into your application. |
9
+ | [**createEmbeddedTemplateUrl()**](TemplateApi.md#createEmbeddedTemplateUrl) | **POST** /v1/template/createEmbeddedTemplateUrl | Generates a create URL to embeds template create process into your application. |
10
+ | [**createTemplate()**](TemplateApi.md#createTemplate) | **POST** /v1/template/create | Creates a new template. |
11
+ | [**deleteTemplate()**](TemplateApi.md#deleteTemplate) | **DELETE** /v1/template/delete | Deletes a template. |
12
+ | [**deleteTag()**](TemplateApi.md#deleteTag) | **DELETE** /v1/template/deleteTags | Delete the Tags in Templates. |
13
+ | [**download()**](TemplateApi.md#download) | **GET** /v1/template/download | Download the template. |
14
+ | [**editTemplate()**](TemplateApi.md#editTemplate) | **PUT** /v1/template/edit | Edit and updates an existing template. |
15
+ | [**getEmbeddedTemplateEditUrl()**](TemplateApi.md#getEmbeddedTemplateEditUrl) | **POST** /v1/template/getEmbeddedTemplateEditUrl | Generates a edit URL to embeds template edit process into your application. |
16
+ | [**getProperties()**](TemplateApi.md#getProperties) | **GET** /v1/template/properties | Get summary of the template. |
17
+ | [**listTemplates()**](TemplateApi.md#listTemplates) | **GET** /v1/template/list | List all the templates. |
18
+ | [**mergeAndSend()**](TemplateApi.md#mergeAndSend) | **POST** /v1/template/mergeAndSend | Send the document by merging multiple templates. |
19
+ | [**mergeCreateEmbeddedRequestUrlTemplate()**](TemplateApi.md#mergeCreateEmbeddedRequestUrlTemplate) | **POST** /v1/template/mergeCreateEmbeddedRequestUrl | Generates a merge request URL using a template that combines document merging and sending processes into your application. |
20
+ | [**sendUsingTemplate()**](TemplateApi.md#sendUsingTemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
21
+
22
+
23
+ ## `addTag()`
24
+
25
+ ```typescript
26
+ addTag(templateTag: TemplateTag)
27
+ ```
28
+
29
+ Add the Tags in Templates.
30
+
31
+
32
+ ### Parameters
33
+
34
+ |Name | Type | Description | Notes |
35
+ | ------------- | ------------- | ------------- | ------------- |
36
+ | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| ContainsTemplateId and Label Names for AddingTags. | [optional] |
37
+
38
+ ### Return type
39
+
40
+ void (empty response body)
41
+
42
+ ### Authorization
43
+
44
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
45
+
46
+ ### HTTP request headers
47
+
48
+ - **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`
49
+ - **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`
50
+
51
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
52
+ [[Back to Model list]](../README.md#models)
53
+ [[Back to README]](../README.md)
54
+
55
+ ## `createEmbeddedRequestUrlTemplate()`
56
+
57
+ ```typescript
58
+ createEmbeddedRequestUrlTemplate(templateId: string, embeddedSendTemplateFormRequest: EmbeddedSendTemplateFormRequest): EmbeddedSendCreated
59
+ ```
60
+
61
+ Generates a send URL using a template which embeds document sending process into your application.
62
+
63
+
64
+ ### Parameters
65
+
66
+ |Name | Type | Description | Notes |
67
+ | ------------- | ------------- | ------------- | ------------- |
68
+ | **templateId** | **string**| The template id. | |
69
+ | **embeddedSendTemplateFormRequest** | [**EmbeddedSendTemplateFormRequest**](../docs/EmbeddedSendTemplateFormRequest.md)| Embedded send template json request. | [optional] |
70
+
71
+ ### Return type
72
+
73
+ [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
74
+
75
+ ### Authorization
76
+
77
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
78
+
79
+ ### HTTP request headers
80
+
81
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
82
+ - **Accept**: `application/json`
83
+
84
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
85
+ [[Back to Model list]](../README.md#models)
86
+ [[Back to README]](../README.md)
87
+
88
+ ## `createEmbeddedTemplateUrl()`
89
+
90
+ ```typescript
91
+ createEmbeddedTemplateUrl(embeddedCreateTemplateRequest: EmbeddedCreateTemplateRequest): EmbeddedTemplateCreated
92
+ ```
93
+
94
+ Generates a create URL to embeds template create process into your application.
95
+
96
+
97
+ ### Parameters
98
+
99
+ |Name | Type | Description | Notes |
100
+ | ------------- | ------------- | ------------- | ------------- |
101
+ | **embeddedCreateTemplateRequest** | [**EmbeddedCreateTemplateRequest**](../docs/EmbeddedCreateTemplateRequest.md)| The create embedded template request body. | [optional] |
102
+
103
+ ### Return type
104
+
105
+ [**EmbeddedTemplateCreated**](../docs/EmbeddedTemplateCreated.md)
106
+
107
+ ### Authorization
108
+
109
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
110
+
111
+ ### HTTP request headers
112
+
113
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
114
+ - **Accept**: `application/json`
115
+
116
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
117
+ [[Back to Model list]](../README.md#models)
118
+ [[Back to README]](../README.md)
119
+
120
+ ## `createTemplate()`
121
+
122
+ ```typescript
123
+ createTemplate(createTemplateRequest: CreateTemplateRequest): TemplateCreated
124
+ ```
125
+
126
+ Creates a new template.
127
+
128
+
129
+ ### Parameters
130
+
131
+ |Name | Type | Description | Notes |
132
+ | ------------- | ------------- | ------------- | ------------- |
133
+ | **createTemplateRequest** | [**CreateTemplateRequest**](../docs/CreateTemplateRequest.md)| The create template request body. | [optional] |
134
+
135
+ ### Return type
136
+
137
+ [**TemplateCreated**](../docs/TemplateCreated.md)
138
+
139
+ ### Authorization
140
+
141
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
142
+
143
+ ### HTTP request headers
144
+
145
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
146
+ - **Accept**: `application/json`
147
+
148
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
149
+ [[Back to Model list]](../README.md#models)
150
+ [[Back to README]](../README.md)
151
+
152
+ ## `deleteTemplate()`
153
+
154
+ ```typescript
155
+ deleteTemplate(templateId: string, onBehalfOf: string)
156
+ ```
157
+
158
+ Deletes a template.
159
+
160
+
161
+ ### Parameters
162
+
163
+ |Name | Type | Description | Notes |
164
+ | ------------- | ------------- | ------------- | ------------- |
165
+ | **templateId** | **string**| The template id. | |
166
+ | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
167
+
168
+ ### Return type
169
+
170
+ void (empty response body)
171
+
172
+ ### Authorization
173
+
174
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
175
+
176
+ ### HTTP request headers
177
+
178
+ - **Content-Type**: Not defined
179
+ - **Accept**: `application/json`
180
+
181
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
182
+ [[Back to Model list]](../README.md#models)
183
+ [[Back to README]](../README.md)
184
+
185
+ ## `deleteTag()`
186
+
187
+ ```typescript
188
+ deleteTag(templateTag: TemplateTag)
189
+ ```
190
+
191
+ Delete the Tags in Templates.
192
+
193
+
194
+ ### Parameters
195
+
196
+ |Name | Type | Description | Notes |
197
+ | ------------- | ------------- | ------------- | ------------- |
198
+ | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| Contains TemplateId and LabelNames for Adding Tags. | [optional] |
199
+
200
+ ### Return type
201
+
202
+ void (empty response body)
203
+
204
+ ### Authorization
205
+
206
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
207
+
208
+ ### HTTP request headers
209
+
210
+ - **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`
211
+ - **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`
212
+
213
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
214
+ [[Back to Model list]](../README.md#models)
215
+ [[Back to README]](../README.md)
216
+
217
+ ## `download()`
218
+
219
+ ```typescript
220
+ download(templateId: string, onBehalfOf: string): Buffer
221
+ ```
222
+
223
+ Download the template.
224
+
225
+
226
+ ### Parameters
227
+
228
+ |Name | Type | Description | Notes |
229
+ | ------------- | ------------- | ------------- | ------------- |
230
+ | **templateId** | **string**| Template Id. | |
231
+ | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
232
+
233
+ ### Return type
234
+
235
+ **Buffer**
236
+
237
+ ### Authorization
238
+
239
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
240
+
241
+ ### HTTP request headers
242
+
243
+ - **Content-Type**: Not defined
244
+ - **Accept**: `application/json`
245
+
246
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
247
+ [[Back to Model list]](../README.md#models)
248
+ [[Back to README]](../README.md)
249
+
250
+ ## `editTemplate()`
251
+
252
+ ```typescript
253
+ editTemplate(templateId: string, editTemplateRequest: EditTemplateRequest)
254
+ ```
255
+
256
+ Edit and updates an existing template.
257
+
258
+
259
+ ### Parameters
260
+
261
+ |Name | Type | Description | Notes |
262
+ | ------------- | ------------- | ------------- | ------------- |
263
+ | **templateId** | **string**| The template id. | |
264
+ | **editTemplateRequest** | [**EditTemplateRequest**](../docs/EditTemplateRequest.md)| The edit template request body. | |
265
+
266
+ ### Return type
267
+
268
+ void (empty response body)
269
+
270
+ ### Authorization
271
+
272
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
273
+
274
+ ### HTTP request headers
275
+
276
+ - **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`
277
+ - **Accept**: `application/json`
278
+
279
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
280
+ [[Back to Model list]](../README.md#models)
281
+ [[Back to README]](../README.md)
282
+
283
+ ## `getEmbeddedTemplateEditUrl()`
284
+
285
+ ```typescript
286
+ getEmbeddedTemplateEditUrl(templateId: string, embeddedTemplateEditRequest: EmbeddedTemplateEditRequest): EmbeddedTemplateEdited
287
+ ```
288
+
289
+ Generates a edit URL to embeds template edit process into your application.
290
+
291
+
292
+ ### Parameters
293
+
294
+ |Name | Type | Description | Notes |
295
+ | ------------- | ------------- | ------------- | ------------- |
296
+ | **templateId** | **string**| The template id. | |
297
+ | **embeddedTemplateEditRequest** | [**EmbeddedTemplateEditRequest**](../docs/EmbeddedTemplateEditRequest.md)| The embedded edit template request body. | [optional] |
298
+
299
+ ### Return type
300
+
301
+ [**EmbeddedTemplateEdited**](../docs/EmbeddedTemplateEdited.md)
302
+
303
+ ### Authorization
304
+
305
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
306
+
307
+ ### HTTP request headers
308
+
309
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
310
+ - **Accept**: `application/json`
311
+
312
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
313
+ [[Back to Model list]](../README.md#models)
314
+ [[Back to README]](../README.md)
315
+
316
+ ## `getProperties()`
317
+
318
+ ```typescript
319
+ getProperties(templateId: string): TemplateProperties
320
+ ```
321
+
322
+ Get summary of the template.
323
+
324
+
325
+ ### Parameters
326
+
327
+ |Name | Type | Description | Notes |
328
+ | ------------- | ------------- | ------------- | ------------- |
329
+ | **templateId** | **string**| Template Id. | |
330
+
331
+ ### Return type
332
+
333
+ [**TemplateProperties**](../docs/TemplateProperties.md)
334
+
335
+ ### Authorization
336
+
337
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
338
+
339
+ ### HTTP request headers
340
+
341
+ - **Content-Type**: Not defined
342
+ - **Accept**: `application/json`
343
+
344
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
345
+ [[Back to Model list]](../README.md#models)
346
+ [[Back to README]](../README.md)
347
+
348
+ ## `listTemplates()`
349
+
350
+ ```typescript
351
+ listTemplates(page: number, templateType: 'mytemplates' | 'sharedtemplate' | 'all', pageSize: number, searchKey: string, onBehalfOf: Array<string>, createdBy: Array<string>, templateLabels: Array<string>, startDate: Date, endDate: Date, brandIds: Array<string>): TemplateRecords
352
+ ```
353
+
354
+ List all the templates.
355
+
356
+
357
+ ### Parameters
358
+
359
+ |Name | Type | Description | Notes |
360
+ | ------------- | ------------- | ------------- | ------------- |
361
+ | **page** | **number**| | [default to 1] |
362
+ | **templateType** | **'mytemplates' | 'sharedtemplate' | 'all'**| | [optional] |
363
+ | **pageSize** | **number**| | [optional] [default to 10] |
364
+ | **searchKey** | **string**| | [optional] |
365
+ | **onBehalfOf** | [**Array<string>**](../docs/string.md)| The sender identity\&#39;s email used to filter the templates returned in the API. The API will return templates that were sent on behalf of the specified email address. | [optional] |
366
+ | **createdBy** | [**Array<string>**](../docs/string.md)| The templates can be listed by the creator of the template. | [optional] |
367
+ | **templateLabels** | [**Array<string>**](../docs/string.md)| Labels of the template. | [optional] |
368
+ | **startDate** | **Date**| Start date of the template | [optional] |
369
+ | **endDate** | **Date**| End date of the template | [optional] |
370
+ | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the template. | [optional] |
371
+
372
+ ### Return type
373
+
374
+ [**TemplateRecords**](../docs/TemplateRecords.md)
375
+
376
+ ### Authorization
377
+
378
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
379
+
380
+ ### HTTP request headers
381
+
382
+ - **Content-Type**: Not defined
383
+ - **Accept**: `application/json`
384
+
385
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
386
+ [[Back to Model list]](../README.md#models)
387
+ [[Back to README]](../README.md)
388
+
389
+ ## `mergeAndSend()`
390
+
391
+ ```typescript
392
+ mergeAndSend(mergeAndSendForSignForm: MergeAndSendForSignForm): DocumentCreated
393
+ ```
394
+
395
+ Send the document by merging multiple templates.
396
+
397
+
398
+ ### Parameters
399
+
400
+ |Name | Type | Description | Notes |
401
+ | ------------- | ------------- | ------------- | ------------- |
402
+ | **mergeAndSendForSignForm** | [**MergeAndSendForSignForm**](../docs/MergeAndSendForSignForm.md)| The merge and send details as JSON. | [optional] |
403
+
404
+ ### Return type
405
+
406
+ [**DocumentCreated**](../docs/DocumentCreated.md)
407
+
408
+ ### Authorization
409
+
410
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
411
+
412
+ ### HTTP request headers
413
+
414
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
415
+ - **Accept**: `application/json`
416
+
417
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
418
+ [[Back to Model list]](../README.md#models)
419
+ [[Back to README]](../README.md)
420
+
421
+ ## `mergeCreateEmbeddedRequestUrlTemplate()`
422
+
423
+ ```typescript
424
+ mergeCreateEmbeddedRequestUrlTemplate(embeddedMergeTemplateFormRequest: EmbeddedMergeTemplateFormRequest): EmbeddedSendCreated
425
+ ```
426
+
427
+ Generates a merge request URL using a template that combines document merging and sending processes into your application.
428
+
429
+
430
+ ### Parameters
431
+
432
+ |Name | Type | Description | Notes |
433
+ | ------------- | ------------- | ------------- | ------------- |
434
+ | **embeddedMergeTemplateFormRequest** | [**EmbeddedMergeTemplateFormRequest**](../docs/EmbeddedMergeTemplateFormRequest.md)| Embedded merge and send template json request. | [optional] |
435
+
436
+ ### Return type
437
+
438
+ [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
439
+
440
+ ### Authorization
441
+
442
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
443
+
444
+ ### HTTP request headers
445
+
446
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
447
+ - **Accept**: `application/json`
448
+
449
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
450
+ [[Back to Model list]](../README.md#models)
451
+ [[Back to README]](../README.md)
452
+
453
+ ## `sendUsingTemplate()`
454
+
455
+ ```typescript
456
+ sendUsingTemplate(templateId: string, sendForSignFromTemplateForm: SendForSignFromTemplateForm): DocumentCreated
457
+ ```
458
+
459
+ Send a document for signature using a Template.
460
+
461
+
462
+ ### Parameters
463
+
464
+ |Name | Type | Description | Notes |
465
+ | ------------- | ------------- | ------------- | ------------- |
466
+ | **templateId** | **string**| The template id. | |
467
+ | **sendForSignFromTemplateForm** | [**SendForSignFromTemplateForm**](../docs/SendForSignFromTemplateForm.md)| The send template details as JSON. | [optional] |
468
+
469
+ ### Return type
470
+
471
+ [**DocumentCreated**](../docs/DocumentCreated.md)
472
+
473
+ ### Authorization
474
+
475
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
476
+
477
+ ### HTTP request headers
478
+
479
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
480
+ - **Accept**: `application/json`
481
+
482
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
483
+ [[Back to Model list]](../README.md#models)
484
+ [[Back to README]](../README.md)