boldsign 3.1.4 → 3.2.0

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 (841) hide show
  1. package/.openapi-generator/FILES +188 -184
  2. package/.openapi-generator/VERSION +1 -1
  3. package/.openapi-generator-ignore +23 -23
  4. package/LICENSE +21 -21
  5. package/README.md +350 -345
  6. package/api/apis.ts +208 -208
  7. package/api/brandingApi.ts +1233 -1233
  8. package/api/contactsApi.ts +772 -772
  9. package/api/customFieldApi.ts +817 -817
  10. package/api/documentApi.ts +3470 -3470
  11. package/api/groupContactsApi.ts +779 -779
  12. package/api/identityVerificationApi.ts +586 -586
  13. package/api/index.ts +38 -38
  14. package/api/planApi.ts +274 -274
  15. package/api/senderIdentitiesApi.ts +1017 -1017
  16. package/api/teamsApi.ts +661 -661
  17. package/api/templateApi.ts +2188 -2046
  18. package/api/userApi.ts +1094 -1094
  19. package/api.ts +3 -3
  20. package/dist/api/apis.d.ts +1 -1
  21. package/dist/api/apis.js +1 -1
  22. package/dist/api/templateApi.d.ts +2 -1
  23. package/dist/api/templateApi.js +90 -0
  24. package/dist/api/templateApi.js.map +1 -1
  25. package/dist/model/documentProperties.d.ts +3 -0
  26. package/dist/model/documentProperties.js +15 -0
  27. package/dist/model/documentProperties.js.map +1 -1
  28. package/dist/model/errorResponse.d.ts +15 -0
  29. package/dist/model/errorResponse.js +23 -0
  30. package/dist/model/errorResponse.js.map +1 -0
  31. package/dist/model/index.d.ts +5 -1
  32. package/dist/model/index.js +17 -3
  33. package/dist/model/index.js.map +1 -1
  34. package/dist/model/templateProperties.d.ts +1 -0
  35. package/dist/model/templateProperties.js +5 -0
  36. package/dist/model/templateProperties.js.map +1 -1
  37. package/dist/model/templateShareErrorResponse.d.ts +17 -0
  38. package/dist/model/templateShareErrorResponse.js +33 -0
  39. package/dist/model/templateShareErrorResponse.js.map +1 -0
  40. package/dist/model/templateShareRequest.d.ts +15 -0
  41. package/dist/model/templateShareRequest.js +18 -0
  42. package/dist/model/templateShareRequest.js.map +1 -0
  43. package/dist/model/templateTeamShareRequest.d.ts +26 -0
  44. package/dist/model/templateTeamShareRequest.js +40 -0
  45. package/dist/model/templateTeamShareRequest.js.map +1 -0
  46. package/dist/model/textTagDefinition.d.ts +2 -0
  47. package/dist/model/textTagDefinition.js +5 -0
  48. package/dist/model/textTagDefinition.js.map +1 -1
  49. package/docs/AccessCodeDetail.md +19 -19
  50. package/docs/AccessCodeDetails.md +13 -13
  51. package/docs/Added.md +13 -13
  52. package/docs/Address.md +16 -16
  53. package/docs/AttachmentInfo.md +14 -14
  54. package/docs/AuditTrail.md +25 -25
  55. package/docs/AuthenticationSettings.md +11 -11
  56. package/docs/Base64File.md +12 -12
  57. package/docs/BehalfDocument.md +29 -29
  58. package/docs/BehalfDocumentRecords.md +12 -12
  59. package/docs/BehalfOf.md +12 -12
  60. package/docs/BillingViewModel.md +11 -11
  61. package/docs/BrandCreated.md +11 -11
  62. package/docs/BrandCustomFieldDetails.md +16 -16
  63. package/docs/BrandingApi.md +268 -268
  64. package/docs/BrandingMessage.md +11 -11
  65. package/docs/BrandingRecords.md +11 -11
  66. package/docs/ChangeRecipient.md +18 -18
  67. package/docs/ChangeTeamRequest.md +12 -12
  68. package/docs/CollaborationSettings.md +14 -14
  69. package/docs/ConditionalRule.md +13 -13
  70. package/docs/ContactCreated.md +12 -12
  71. package/docs/ContactDetails.md +15 -15
  72. package/docs/ContactPageDetails.md +13 -13
  73. package/docs/ContactsApi.md +176 -176
  74. package/docs/ContactsDetails.md +16 -16
  75. package/docs/ContactsList.md +12 -12
  76. package/docs/CreateContactResponse.md +11 -11
  77. package/docs/CreateGroupContactResponse.md +12 -12
  78. package/docs/CreateSenderIdentityRequest.md +17 -17
  79. package/docs/CreateTeamRequest.md +11 -11
  80. package/docs/CreateTemplateRequest.md +39 -39
  81. package/docs/CreateUser.md +14 -14
  82. package/docs/Creators.md +12 -12
  83. package/docs/CustomDomainSettings.md +12 -12
  84. package/docs/CustomFieldApi.md +174 -174
  85. package/docs/CustomFieldCollection.md +11 -11
  86. package/docs/CustomFieldMessage.md +12 -12
  87. package/docs/CustomFormField.md +44 -44
  88. package/docs/Date.md +13 -13
  89. package/docs/DeleteCustomFieldReply.md +11 -11
  90. package/docs/Document.md +28 -28
  91. package/docs/DocumentApi.md +891 -891
  92. package/docs/DocumentCC.md +11 -11
  93. package/docs/DocumentCcDetails.md +12 -12
  94. package/docs/DocumentCreated.md +11 -11
  95. package/docs/DocumentEdited.md +11 -11
  96. package/docs/DocumentExpirySettings.md +16 -16
  97. package/docs/DocumentFiles.md +16 -16
  98. package/docs/DocumentFormFields.md +53 -53
  99. package/docs/DocumentInfo.md +14 -14
  100. package/docs/DocumentProperties.md +57 -54
  101. package/docs/DocumentReassign.md +13 -13
  102. package/docs/DocumentRecords.md +12 -12
  103. package/docs/DocumentSenderDetail.md +14 -14
  104. package/docs/DocumentSigner.md +34 -34
  105. package/docs/DocumentSignerDetails.md +41 -41
  106. package/docs/DocumentTags.md +12 -12
  107. package/docs/DownloadImageRequest.md +16 -16
  108. package/docs/EditDocumentFile.md +14 -14
  109. package/docs/EditDocumentRequest.md +41 -41
  110. package/docs/EditDocumentSigner.md +35 -35
  111. package/docs/EditFormField.md +52 -52
  112. package/docs/EditSenderIdentityRequest.md +15 -15
  113. package/docs/EditTemplateRequest.md +34 -34
  114. package/docs/EditableDateFieldSettings.md +14 -14
  115. package/docs/EmbeddedCreateTemplateRequest.md +50 -50
  116. package/docs/EmbeddedCustomFieldCreated.md +11 -11
  117. package/docs/EmbeddedDocumentEditJsonRequest.md +19 -19
  118. package/docs/EmbeddedDocumentEdited.md +11 -11
  119. package/docs/EmbeddedDocumentRequest.md +58 -58
  120. package/docs/EmbeddedFileDetails.md +16 -16
  121. package/docs/EmbeddedFileLink.md +11 -11
  122. package/docs/EmbeddedMergeTemplateFormRequest.md +59 -59
  123. package/docs/EmbeddedSendCreated.md +12 -12
  124. package/docs/EmbeddedSendTemplateFormRequest.md +56 -56
  125. package/docs/EmbeddedSigningLink.md +11 -11
  126. package/docs/EmbeddedTemplateCreated.md +12 -12
  127. package/docs/EmbeddedTemplateEditRequest.md +21 -21
  128. package/docs/EmbeddedTemplateEdited.md +11 -11
  129. package/docs/EmbeddedTemplatePreview.md +11 -11
  130. package/docs/EmbeddedTemplatePreviewJsonRequest.md +12 -12
  131. package/docs/Error.md +12 -12
  132. package/docs/ErrorResult.md +11 -11
  133. package/docs/ExistingFormField.md +15 -15
  134. package/docs/ExtendExpiry.md +14 -14
  135. package/docs/FileInfo.md +14 -14
  136. package/docs/Font.md +18 -18
  137. package/docs/FormField.md +53 -53
  138. package/docs/FormFieldPermission.md +13 -13
  139. package/docs/FormGroup.md +15 -15
  140. package/docs/FormulaFieldSettings.md +12 -12
  141. package/docs/GetGroupContactDetails.md +15 -15
  142. package/docs/GroupContact.md +14 -14
  143. package/docs/GroupContactDetails.md +13 -13
  144. package/docs/GroupContactsApi.md +177 -177
  145. package/docs/GroupContactsList.md +12 -12
  146. package/docs/GroupSigner.md +17 -17
  147. package/docs/GroupSignerSettings.md +12 -12
  148. package/docs/GroupUser.md +12 -12
  149. package/docs/IdDocument.md +21 -21
  150. package/docs/IdReport.md +14 -14
  151. package/docs/IdVerification.md +19 -19
  152. package/docs/IdVerificationDetails.md +20 -20
  153. package/docs/IdentityVerificationApi.md +109 -109
  154. package/docs/IdentityVerificationSettings.md +17 -17
  155. package/docs/ImageInfo.md +13 -13
  156. package/docs/MergeAndSendForSignForm.md +49 -49
  157. package/docs/ModificationDetails.md +12 -12
  158. package/docs/NotificationSettings.md +22 -22
  159. package/docs/PageDetails.md +16 -16
  160. package/docs/PhoneNumber.md +12 -12
  161. package/docs/PlanApi.md +38 -38
  162. package/docs/PrefillField.md +12 -12
  163. package/docs/PrefillFieldRequest.md +12 -12
  164. package/docs/ProblemDetails.md +15 -15
  165. package/docs/RecipientChangeLog.md +12 -12
  166. package/docs/RecipientNotificationSettings.md +22 -22
  167. package/docs/Rectangle.md +14 -14
  168. package/docs/ReminderMessage.md +13 -13
  169. package/docs/ReminderSettings.md +13 -13
  170. package/docs/RemoveAuthentication.md +14 -14
  171. package/docs/Removed.md +13 -13
  172. package/docs/RevokeDocument.md +12 -12
  173. package/docs/Role.md +35 -35
  174. package/docs/Roles.md +36 -36
  175. package/docs/SendForSign.md +48 -48
  176. package/docs/SendForSignFromTemplateForm.md +46 -46
  177. package/docs/SenderIdentitiesApi.md +243 -243
  178. package/docs/SenderIdentityCreated.md +11 -11
  179. package/docs/SenderIdentityList.md +12 -12
  180. package/docs/SenderIdentityViewModel.md +21 -21
  181. package/docs/SignatureFrameSettings.md +14 -14
  182. package/docs/SignerAuthenticationSettings.md +12 -12
  183. package/docs/Size.md +12 -12
  184. package/docs/TeamCreated.md +11 -11
  185. package/docs/TeamDocumentRecords.md +12 -12
  186. package/docs/TeamListResponse.md +12 -12
  187. package/docs/TeamPageDetails.md +12 -12
  188. package/docs/TeamResponse.md +15 -15
  189. package/docs/TeamUpdateRequest.md +12 -12
  190. package/docs/TeamUsers.md +16 -16
  191. package/docs/Teams.md +14 -14
  192. package/docs/TeamsApi.md +141 -141
  193. package/docs/Template.md +29 -29
  194. package/docs/TemplateApi.md +554 -520
  195. package/docs/TemplateCC.md +12 -12
  196. package/docs/TemplateCreated.md +11 -11
  197. package/docs/TemplateFiles.md +14 -14
  198. package/docs/TemplateFormFields.md +53 -53
  199. package/docs/TemplateGroupSigner.md +12 -12
  200. package/docs/TemplateProperties.md +42 -41
  201. package/docs/TemplateRecords.md +12 -12
  202. package/docs/TemplateRole.md +30 -30
  203. package/docs/TemplateSenderDetail.md +12 -12
  204. package/docs/TemplateSenderDetails.md +13 -13
  205. package/docs/TemplateSharedTemplateDetail.md +12 -12
  206. package/docs/TemplateSharing.md +11 -11
  207. package/docs/TemplateSignerDetails.md +29 -29
  208. package/docs/TemplateTag.md +14 -14
  209. package/docs/TemplateTeamShare.md +12 -12
  210. package/docs/TextTagDefinition.md +43 -42
  211. package/docs/TextTagOffset.md +12 -12
  212. package/docs/UpdateGroupContact.md +13 -13
  213. package/docs/UpdateUser.md +14 -14
  214. package/docs/UpdateUserMetaData.md +12 -12
  215. package/docs/UserApi.md +275 -275
  216. package/docs/UserPageDetails.md +12 -12
  217. package/docs/UserProperties.md +21 -21
  218. package/docs/UserRecords.md +12 -12
  219. package/docs/UsersDetails.md +21 -21
  220. package/docs/Validation.md +13 -13
  221. package/docs/VerificationDataRequest.md +15 -15
  222. package/docs/ViewBrandDetails.md +36 -36
  223. package/docs/ViewCustomFieldDetails.md +17 -17
  224. package/git_push.sh +57 -57
  225. package/model/accessCodeDetail.ts +91 -91
  226. package/model/accessCodeDetails.ts +44 -44
  227. package/model/added.ts +43 -43
  228. package/model/address.ts +61 -61
  229. package/model/attachmentInfo.ts +49 -49
  230. package/model/auditTrail.ts +201 -201
  231. package/model/authenticationSettings.ts +39 -39
  232. package/model/base64File.ts +37 -37
  233. package/model/behalfDocument.ts +154 -154
  234. package/model/behalfDocumentRecords.ts +39 -39
  235. package/model/behalfOf.ts +37 -37
  236. package/model/billingViewModel.ts +31 -31
  237. package/model/brandCreated.ts +31 -31
  238. package/model/brandCustomFieldDetails.ts +62 -62
  239. package/model/brandingMessage.ts +31 -31
  240. package/model/brandingRecords.ts +32 -32
  241. package/model/changeRecipient.ts +74 -74
  242. package/model/changeTeamRequest.ts +37 -37
  243. package/model/collaborationSettings.ts +49 -49
  244. package/model/conditionalRule.ts +43 -43
  245. package/model/contactCreated.ts +37 -37
  246. package/model/contactDetails.ts +56 -56
  247. package/model/contactPageDetails.ts +43 -43
  248. package/model/contactsDetails.ts +62 -62
  249. package/model/contactsList.ts +39 -39
  250. package/model/createContactResponse.ts +32 -32
  251. package/model/createGroupContactResponse.ts +37 -37
  252. package/model/createSenderIdentityRequest.ts +93 -93
  253. package/model/createTeamRequest.ts +31 -31
  254. package/model/createTemplateRequest.ts +214 -214
  255. package/model/createUser.ts +56 -56
  256. package/model/creators.ts +37 -37
  257. package/model/customDomainSettings.ts +37 -37
  258. package/model/customFieldCollection.ts +32 -32
  259. package/model/customFieldMessage.ts +37 -37
  260. package/model/customFormField.ts +282 -282
  261. package/model/deleteCustomFieldReply.ts +31 -31
  262. package/model/document.ts +147 -147
  263. package/model/documentCC.ts +31 -31
  264. package/model/documentCcDetails.ts +37 -37
  265. package/model/documentCreated.ts +31 -31
  266. package/model/documentEdited.ts +37 -37
  267. package/model/documentExpirySettings.ts +68 -68
  268. package/model/documentFiles.ts +61 -61
  269. package/model/documentFormFields.ts +316 -316
  270. package/model/documentInfo.ts +100 -100
  271. package/model/documentProperties.ts +364 -346
  272. package/model/documentReassign.ts +43 -43
  273. package/model/documentRecords.ts +39 -39
  274. package/model/documentSenderDetail.ts +49 -49
  275. package/model/documentSigner.ts +247 -247
  276. package/model/documentSignerDetails.ts +298 -298
  277. package/model/documentTags.ts +37 -37
  278. package/model/downloadImageRequest.ts +61 -61
  279. package/model/editDocumentFile.ts +56 -56
  280. package/model/editDocumentRequest.ts +236 -236
  281. package/model/editDocumentSigner.ts +255 -255
  282. package/model/editFormField.ts +338 -338
  283. package/model/editSenderIdentityRequest.ts +81 -81
  284. package/model/editTemplateRequest.ts +183 -183
  285. package/model/editableDateFieldSettings.ts +49 -49
  286. package/model/embeddedCreateTemplateRequest.ts +307 -307
  287. package/model/embeddedCustomFieldCreated.ts +31 -31
  288. package/model/embeddedDocumentEditJsonRequest.ts +108 -108
  289. package/model/embeddedDocumentEdited.ts +31 -31
  290. package/model/embeddedDocumentRequest.ts +364 -364
  291. package/model/embeddedFileDetails.ts +61 -61
  292. package/model/embeddedFileLink.ts +31 -31
  293. package/model/embeddedMergeTemplateFormRequest.ts +370 -370
  294. package/model/embeddedSendCreated.ts +37 -37
  295. package/model/embeddedSendTemplateFormRequest.ts +351 -351
  296. package/model/embeddedSigningLink.ts +31 -31
  297. package/model/embeddedTemplateCreated.ts +37 -37
  298. package/model/embeddedTemplateEditRequest.ts +120 -120
  299. package/model/embeddedTemplateEdited.ts +31 -31
  300. package/model/embeddedTemplatePreview.ts +31 -31
  301. package/model/embeddedTemplatePreviewJsonRequest.ts +37 -37
  302. package/model/errorResponse.ts +37 -0
  303. package/model/errorResult.ts +31 -31
  304. package/model/existingFormField.ts +55 -55
  305. package/model/extendExpiry.ts +49 -49
  306. package/model/fileInfo.ts +49 -49
  307. package/model/font.ts +88 -88
  308. package/model/formField.ts +340 -340
  309. package/model/formFieldPermission.ts +43 -43
  310. package/model/formGroup.ts +63 -63
  311. package/model/formulaFieldSettings.ts +37 -37
  312. package/model/getGroupContactDetails.ts +57 -57
  313. package/model/groupContact.ts +50 -50
  314. package/model/groupContactDetails.ts +44 -44
  315. package/model/groupContactsList.ts +39 -39
  316. package/model/groupSigner.ts +77 -77
  317. package/model/groupSignerSettings.ts +37 -37
  318. package/model/groupUser.ts +37 -37
  319. package/model/idDocument.ts +93 -93
  320. package/model/idReport.ts +50 -50
  321. package/model/idVerification.ts +79 -79
  322. package/model/idVerificationDetails.ts +85 -85
  323. package/model/identityVerificationSettings.ts +84 -84
  324. package/model/imageInfo.ts +43 -43
  325. package/model/index.ts +680 -666
  326. package/model/mergeAndSendForSignForm.ts +283 -283
  327. package/model/modelDate.ts +43 -43
  328. package/model/modelError.ts +37 -37
  329. package/model/models.ts +244 -244
  330. package/model/modificationDetails.ts +37 -37
  331. package/model/notificationSettings.ts +97 -97
  332. package/model/pageDetails.ts +61 -61
  333. package/model/phoneNumber.ts +37 -37
  334. package/model/prefillField.ts +37 -37
  335. package/model/prefillFieldRequest.ts +38 -38
  336. package/model/problemDetails.ts +55 -55
  337. package/model/recipientChangeLog.ts +39 -39
  338. package/model/recipientNotificationSettings.ts +97 -97
  339. package/model/rectangle.ts +49 -49
  340. package/model/reminderMessage.ts +44 -44
  341. package/model/reminderSettings.ts +43 -43
  342. package/model/removeAuthentication.ts +50 -50
  343. package/model/removed.ts +43 -43
  344. package/model/revokeDocument.ts +37 -37
  345. package/model/role.ts +254 -254
  346. package/model/roles.ts +258 -258
  347. package/model/sendForSign.ts +277 -277
  348. package/model/sendForSignFromTemplateForm.ts +264 -264
  349. package/model/senderIdentityCreated.ts +31 -31
  350. package/model/senderIdentityList.ts +39 -39
  351. package/model/senderIdentityViewModel.ts +92 -92
  352. package/model/signatureFrameSettings.ts +49 -49
  353. package/model/signerAuthenticationSettings.ts +37 -37
  354. package/model/size.ts +37 -37
  355. package/model/teamCreated.ts +31 -31
  356. package/model/teamDocumentRecords.ts +39 -39
  357. package/model/teamListResponse.ts +39 -39
  358. package/model/teamPageDetails.ts +37 -37
  359. package/model/teamResponse.ts +56 -56
  360. package/model/teamUpdateRequest.ts +37 -37
  361. package/model/teamUsers.ts +73 -73
  362. package/model/teams.ts +49 -49
  363. package/model/template.ts +159 -159
  364. package/model/templateCC.ts +37 -37
  365. package/model/templateCreated.ts +31 -31
  366. package/model/templateFiles.ts +49 -49
  367. package/model/templateFormFields.ts +315 -315
  368. package/model/templateGroupSigner.ts +37 -37
  369. package/model/templateProperties.ts +240 -234
  370. package/model/templateRecords.ts +39 -39
  371. package/model/templateRole.ts +221 -221
  372. package/model/templateSenderDetail.ts +37 -37
  373. package/model/templateSenderDetails.ts +43 -43
  374. package/model/templateShareErrorResponse.ts +49 -0
  375. package/model/templateShareRequest.ts +32 -0
  376. package/model/templateSharedTemplateDetail.ts +43 -43
  377. package/model/templateSharing.ts +32 -32
  378. package/model/templateSignerDetails.ts +173 -173
  379. package/model/templateTag.ts +49 -49
  380. package/model/templateTeamShare.ts +44 -44
  381. package/model/templateTeamShareRequest.ts +53 -0
  382. package/model/textTagDefinition.ts +268 -261
  383. package/model/textTagOffset.ts +37 -37
  384. package/model/updateGroupContact.ts +44 -44
  385. package/model/updateUser.ts +60 -60
  386. package/model/updateUserMetaData.ts +37 -37
  387. package/model/userPageDetails.ts +37 -37
  388. package/model/userProperties.ts +91 -91
  389. package/model/userRecords.ts +39 -39
  390. package/model/usersDetails.ts +91 -91
  391. package/model/validation.ts +52 -52
  392. package/model/verificationDataRequest.ts +55 -55
  393. package/model/viewBrandDetails.ts +190 -190
  394. package/model/viewCustomFieldDetails.ts +68 -68
  395. package/package.json +52 -52
  396. package/tsconfig.json +24 -24
  397. package/boldsign-3.1.4.tgz +0 -0
  398. package/dist/examples/DocumentProperties.d.ts +0 -1
  399. package/dist/examples/DocumentProperties.js +0 -28
  400. package/dist/examples/DocumentProperties.js.map +0 -1
  401. package/dist/examples/brandCreate.d.ts +0 -1
  402. package/dist/examples/brandCreate.js +0 -68
  403. package/dist/examples/brandCreate.js.map +0 -1
  404. package/dist/examples/brandDelete.d.ts +0 -1
  405. package/dist/examples/brandDelete.js +0 -28
  406. package/dist/examples/brandDelete.js.map +0 -1
  407. package/dist/examples/brandGet.d.ts +0 -1
  408. package/dist/examples/brandGet.js +0 -28
  409. package/dist/examples/brandGet.js.map +0 -1
  410. package/dist/examples/brandList.d.ts +0 -1
  411. package/dist/examples/brandList.js +0 -27
  412. package/dist/examples/brandList.js.map +0 -1
  413. package/dist/examples/brandResetDefault.d.ts +0 -1
  414. package/dist/examples/brandResetDefault.js +0 -28
  415. package/dist/examples/brandResetDefault.js.map +0 -1
  416. package/dist/examples/brandUpdate.d.ts +0 -1
  417. package/dist/examples/brandUpdate.js +0 -68
  418. package/dist/examples/brandUpdate.js.map +0 -1
  419. package/dist/examples/contactCreate.d.ts +0 -1
  420. package/dist/examples/contactCreate.js +0 -38
  421. package/dist/examples/contactCreate.js.map +0 -1
  422. package/dist/examples/contactDelete.d.ts +0 -1
  423. package/dist/examples/contactDelete.js +0 -28
  424. package/dist/examples/contactDelete.js.map +0 -1
  425. package/dist/examples/contactGet.d.ts +0 -1
  426. package/dist/examples/contactGet.js +0 -28
  427. package/dist/examples/contactGet.js.map +0 -1
  428. package/dist/examples/contactGroupDelete.d.ts +0 -1
  429. package/dist/examples/contactGroupDelete.js +0 -27
  430. package/dist/examples/contactGroupDelete.js.map +0 -1
  431. package/dist/examples/contactGroupGet.d.ts +0 -1
  432. package/dist/examples/contactGroupGet.js +0 -27
  433. package/dist/examples/contactGroupGet.js.map +0 -1
  434. package/dist/examples/contactGroupList.d.ts +0 -1
  435. package/dist/examples/contactGroupList.js +0 -29
  436. package/dist/examples/contactGroupList.js.map +0 -1
  437. package/dist/examples/contactGroupUpdate.d.ts +0 -1
  438. package/dist/examples/contactGroupUpdate.js +0 -34
  439. package/dist/examples/contactGroupUpdate.js.map +0 -1
  440. package/dist/examples/contactGroupsCreate.d.ts +0 -1
  441. package/dist/examples/contactGroupsCreate.js +0 -35
  442. package/dist/examples/contactGroupsCreate.js.map +0 -1
  443. package/dist/examples/contactList.d.ts +0 -1
  444. package/dist/examples/contactList.js +0 -29
  445. package/dist/examples/contactList.js.map +0 -1
  446. package/dist/examples/contactUpdate.d.ts +0 -1
  447. package/dist/examples/contactUpdate.js +0 -38
  448. package/dist/examples/contactUpdate.js.map +0 -1
  449. package/dist/examples/customFieldCreate.d.ts +0 -1
  450. package/dist/examples/customFieldCreate.js +0 -39
  451. package/dist/examples/customFieldCreate.js.map +0 -1
  452. package/dist/examples/customFieldDelete.d.ts +0 -1
  453. package/dist/examples/customFieldDelete.js +0 -28
  454. package/dist/examples/customFieldDelete.js.map +0 -1
  455. package/dist/examples/customFieldEdit.d.ts +0 -1
  456. package/dist/examples/customFieldEdit.js +0 -40
  457. package/dist/examples/customFieldEdit.js.map +0 -1
  458. package/dist/examples/customFieldEmbeddedCreateUrl.d.ts +0 -1
  459. package/dist/examples/customFieldEmbeddedCreateUrl.js +0 -31
  460. package/dist/examples/customFieldEmbeddedCreateUrl.js.map +0 -1
  461. package/dist/examples/customFieldList.d.ts +0 -1
  462. package/dist/examples/customFieldList.js +0 -28
  463. package/dist/examples/customFieldList.js.map +0 -1
  464. package/dist/examples/documentAddAuthentication.d.ts +0 -1
  465. package/dist/examples/documentAddAuthentication.js +0 -32
  466. package/dist/examples/documentAddAuthentication.js.map +0 -1
  467. package/dist/examples/documentAddTags.d.ts +0 -1
  468. package/dist/examples/documentAddTags.js +0 -31
  469. package/dist/examples/documentAddTags.js.map +0 -1
  470. package/dist/examples/documentCancelEditing.d.ts +0 -1
  471. package/dist/examples/documentCancelEditing.js +0 -27
  472. package/dist/examples/documentCancelEditing.js.map +0 -1
  473. package/dist/examples/documentChangeAccessCode.d.ts +0 -1
  474. package/dist/examples/documentChangeAccessCode.js +0 -32
  475. package/dist/examples/documentChangeAccessCode.js.map +0 -1
  476. package/dist/examples/documentChangeRecipients.d.ts +0 -1
  477. package/dist/examples/documentChangeRecipients.js +0 -34
  478. package/dist/examples/documentChangeRecipients.js.map +0 -1
  479. package/dist/examples/documentCreateEmbeddedEditUrl.d.ts +0 -1
  480. package/dist/examples/documentCreateEmbeddedEditUrl.js +0 -32
  481. package/dist/examples/documentCreateEmbeddedEditUrl.js.map +0 -1
  482. package/dist/examples/documentDelete.d.ts +0 -1
  483. package/dist/examples/documentDelete.js +0 -29
  484. package/dist/examples/documentDelete.js.map +0 -1
  485. package/dist/examples/documentDeleteTags.d.ts +0 -1
  486. package/dist/examples/documentDeleteTags.js +0 -31
  487. package/dist/examples/documentDeleteTags.js.map +0 -1
  488. package/dist/examples/documentDownload.d.ts +0 -1
  489. package/dist/examples/documentDownload.js +0 -29
  490. package/dist/examples/documentDownload.js.map +0 -1
  491. package/dist/examples/documentDownloadAttachment.d.ts +0 -1
  492. package/dist/examples/documentDownloadAttachment.js +0 -30
  493. package/dist/examples/documentDownloadAttachment.js.map +0 -1
  494. package/dist/examples/documentDownloadAuditTrial.d.ts +0 -1
  495. package/dist/examples/documentDownloadAuditTrial.js +0 -29
  496. package/dist/examples/documentDownloadAuditTrial.js.map +0 -1
  497. package/dist/examples/documentEdit.d.ts +0 -1
  498. package/dist/examples/documentEdit.js +0 -86
  499. package/dist/examples/documentEdit.js.map +0 -1
  500. package/dist/examples/documentEmbeddedRequestLink.d.ts +0 -1
  501. package/dist/examples/documentEmbeddedRequestLink.js +0 -96
  502. package/dist/examples/documentEmbeddedRequestLink.js.map +0 -1
  503. package/dist/examples/documentEmbeddedSignLink.d.ts +0 -1
  504. package/dist/examples/documentEmbeddedSignLink.js +0 -35
  505. package/dist/examples/documentEmbeddedSignLink.js.map +0 -1
  506. package/dist/examples/documentExtendExpiry.d.ts +0 -1
  507. package/dist/examples/documentExtendExpiry.js +0 -32
  508. package/dist/examples/documentExtendExpiry.js.map +0 -1
  509. package/dist/examples/documentList.d.ts +0 -1
  510. package/dist/examples/documentList.js +0 -29
  511. package/dist/examples/documentList.js.map +0 -1
  512. package/dist/examples/documentListBehalf.d.ts +0 -1
  513. package/dist/examples/documentListBehalf.js +0 -28
  514. package/dist/examples/documentListBehalf.js.map +0 -1
  515. package/dist/examples/documentListTeam.d.ts +0 -1
  516. package/dist/examples/documentListTeam.js +0 -28
  517. package/dist/examples/documentListTeam.js.map +0 -1
  518. package/dist/examples/documentPrefillFieldCheckBox.d.ts +0 -1
  519. package/dist/examples/documentPrefillFieldCheckBox.js +0 -34
  520. package/dist/examples/documentPrefillFieldCheckBox.js.map +0 -1
  521. package/dist/examples/documentPrefillFieldDropDown.d.ts +0 -1
  522. package/dist/examples/documentPrefillFieldDropDown.js +0 -34
  523. package/dist/examples/documentPrefillFieldDropDown.js.map +0 -1
  524. package/dist/examples/documentPrefillFieldEditableDate.d.ts +0 -1
  525. package/dist/examples/documentPrefillFieldEditableDate.js +0 -34
  526. package/dist/examples/documentPrefillFieldEditableDate.js.map +0 -1
  527. package/dist/examples/documentPrefillFieldImage.d.ts +0 -1
  528. package/dist/examples/documentPrefillFieldImage.js +0 -34
  529. package/dist/examples/documentPrefillFieldImage.js.map +0 -1
  530. package/dist/examples/documentPrefillFieldRadioButton.d.ts +0 -1
  531. package/dist/examples/documentPrefillFieldRadioButton.js +0 -34
  532. package/dist/examples/documentPrefillFieldRadioButton.js.map +0 -1
  533. package/dist/examples/documentPrefillFieldTextBox.d.ts +0 -1
  534. package/dist/examples/documentPrefillFieldTextBox.js +0 -34
  535. package/dist/examples/documentPrefillFieldTextBox.js.map +0 -1
  536. package/dist/examples/documentRemoveAuthentication.d.ts +0 -1
  537. package/dist/examples/documentRemoveAuthentication.js +0 -31
  538. package/dist/examples/documentRemoveAuthentication.js.map +0 -1
  539. package/dist/examples/documentRevoke.d.ts +0 -1
  540. package/dist/examples/documentRevoke.js +0 -31
  541. package/dist/examples/documentRevoke.js.map +0 -1
  542. package/dist/examples/documentSend.d.ts +0 -1
  543. package/dist/examples/documentSend.js +0 -90
  544. package/dist/examples/documentSend.js.map +0 -1
  545. package/dist/examples/documentSendOnBehalf.d.ts +0 -1
  546. package/dist/examples/documentSendOnBehalf.js +0 -101
  547. package/dist/examples/documentSendOnBehalf.js.map +0 -1
  548. package/dist/examples/documentSendReminder.d.ts +0 -1
  549. package/dist/examples/documentSendReminder.js +0 -32
  550. package/dist/examples/documentSendReminder.js.map +0 -1
  551. package/dist/examples/draftSend.d.ts +0 -1
  552. package/dist/examples/draftSend.js +0 -27
  553. package/dist/examples/draftSend.js.map +0 -1
  554. package/dist/examples/embeddedCreatePreviewUrl.d.ts +0 -1
  555. package/dist/examples/embeddedCreatePreviewUrl.js +0 -29
  556. package/dist/examples/embeddedCreatePreviewUrl.js.map +0 -1
  557. package/dist/examples/embeddedManualVerification.d.ts +0 -1
  558. package/dist/examples/embeddedManualVerification.js +0 -34
  559. package/dist/examples/embeddedManualVerification.js.map +0 -1
  560. package/dist/examples/identityVerificationImage.d.ts +0 -1
  561. package/dist/examples/identityVerificationImage.js +0 -34
  562. package/dist/examples/identityVerificationImage.js.map +0 -1
  563. package/dist/examples/identityVerificationReport.d.ts +0 -1
  564. package/dist/examples/identityVerificationReport.js +0 -33
  565. package/dist/examples/identityVerificationReport.js.map +0 -1
  566. package/dist/examples/listTemplate.d.ts +0 -1
  567. package/dist/examples/listTemplate.js +0 -29
  568. package/dist/examples/listTemplate.js.map +0 -1
  569. package/dist/examples/plan.d.ts +0 -1
  570. package/dist/examples/plan.js +0 -27
  571. package/dist/examples/plan.js.map +0 -1
  572. package/dist/examples/senderIdentityCreate.d.ts +0 -1
  573. package/dist/examples/senderIdentityCreate.js +0 -33
  574. package/dist/examples/senderIdentityCreate.js.map +0 -1
  575. package/dist/examples/senderIdentityDelete.d.ts +0 -1
  576. package/dist/examples/senderIdentityDelete.js +0 -28
  577. package/dist/examples/senderIdentityDelete.js.map +0 -1
  578. package/dist/examples/senderIdentityList.d.ts +0 -1
  579. package/dist/examples/senderIdentityList.js +0 -29
  580. package/dist/examples/senderIdentityList.js.map +0 -1
  581. package/dist/examples/senderIdentityProperties.d.ts +0 -1
  582. package/dist/examples/senderIdentityProperties.js +0 -27
  583. package/dist/examples/senderIdentityProperties.js.map +0 -1
  584. package/dist/examples/senderIdentityRerequest.d.ts +0 -1
  585. package/dist/examples/senderIdentityRerequest.js +0 -28
  586. package/dist/examples/senderIdentityRerequest.js.map +0 -1
  587. package/dist/examples/senderIdentityResendInvitation.d.ts +0 -1
  588. package/dist/examples/senderIdentityResendInvitation.js +0 -28
  589. package/dist/examples/senderIdentityResendInvitation.js.map +0 -1
  590. package/dist/examples/senderIdentityUpdate.d.ts +0 -1
  591. package/dist/examples/senderIdentityUpdate.js +0 -32
  592. package/dist/examples/senderIdentityUpdate.js.map +0 -1
  593. package/dist/examples/teamCreate.d.ts +0 -1
  594. package/dist/examples/teamCreate.js +0 -30
  595. package/dist/examples/teamCreate.js.map +0 -1
  596. package/dist/examples/teamGet.d.ts +0 -1
  597. package/dist/examples/teamGet.js +0 -28
  598. package/dist/examples/teamGet.js.map +0 -1
  599. package/dist/examples/teamList.d.ts +0 -1
  600. package/dist/examples/teamList.js +0 -29
  601. package/dist/examples/teamList.js.map +0 -1
  602. package/dist/examples/teamUpdate.d.ts +0 -1
  603. package/dist/examples/teamUpdate.js +0 -31
  604. package/dist/examples/teamUpdate.js.map +0 -1
  605. package/dist/examples/templateAddTag.d.ts +0 -1
  606. package/dist/examples/templateAddTag.js +0 -32
  607. package/dist/examples/templateAddTag.js.map +0 -1
  608. package/dist/examples/templateCreate.d.ts +0 -1
  609. package/dist/examples/templateCreate.js +0 -91
  610. package/dist/examples/templateCreate.js.map +0 -1
  611. package/dist/examples/templateDelete.d.ts +0 -1
  612. package/dist/examples/templateDelete.js +0 -28
  613. package/dist/examples/templateDelete.js.map +0 -1
  614. package/dist/examples/templateDeleteTag.d.ts +0 -1
  615. package/dist/examples/templateDeleteTag.js +0 -32
  616. package/dist/examples/templateDeleteTag.js.map +0 -1
  617. package/dist/examples/templateDetails.d.ts +0 -1
  618. package/dist/examples/templateDetails.js +0 -28
  619. package/dist/examples/templateDetails.js.map +0 -1
  620. package/dist/examples/templateDownload.d.ts +0 -1
  621. package/dist/examples/templateDownload.js +0 -28
  622. package/dist/examples/templateDownload.js.map +0 -1
  623. package/dist/examples/templateEdit.d.ts +0 -1
  624. package/dist/examples/templateEdit.js +0 -39
  625. package/dist/examples/templateEdit.js.map +0 -1
  626. package/dist/examples/templateEmbeddedCreate.d.ts +0 -1
  627. package/dist/examples/templateEmbeddedCreate.js +0 -76
  628. package/dist/examples/templateEmbeddedCreate.js.map +0 -1
  629. package/dist/examples/templateEmbeddedEdit.d.ts +0 -1
  630. package/dist/examples/templateEmbeddedEdit.js +0 -36
  631. package/dist/examples/templateEmbeddedEdit.js.map +0 -1
  632. package/dist/examples/templateEmbeddedRequestLink.d.ts +0 -1
  633. package/dist/examples/templateEmbeddedRequestLink.js +0 -78
  634. package/dist/examples/templateEmbeddedRequestLink.js.map +0 -1
  635. package/dist/examples/templateMergerEmbeddedRequestUrl.d.ts +0 -1
  636. package/dist/examples/templateMergerEmbeddedRequestUrl.js +0 -80
  637. package/dist/examples/templateMergerEmbeddedRequestUrl.js.map +0 -1
  638. package/dist/examples/templateSendDocument.d.ts +0 -1
  639. package/dist/examples/templateSendDocument.js +0 -102
  640. package/dist/examples/templateSendDocument.js.map +0 -1
  641. package/dist/examples/templateSendDocumentUsingMultipleTemplate.d.ts +0 -1
  642. package/dist/examples/templateSendDocumentUsingMultipleTemplate.js +0 -50
  643. package/dist/examples/templateSendDocumentUsingMultipleTemplate.js.map +0 -1
  644. package/dist/examples/userChangeTeam.d.ts +0 -1
  645. package/dist/examples/userChangeTeam.js +0 -30
  646. package/dist/examples/userChangeTeam.js.map +0 -1
  647. package/dist/examples/userCreate.d.ts +0 -1
  648. package/dist/examples/userCreate.js +0 -32
  649. package/dist/examples/userCreate.js.map +0 -1
  650. package/dist/examples/userGet.d.ts +0 -1
  651. package/dist/examples/userGet.js +0 -28
  652. package/dist/examples/userGet.js.map +0 -1
  653. package/dist/examples/userInvitationCancel.d.ts +0 -1
  654. package/dist/examples/userInvitationCancel.js +0 -28
  655. package/dist/examples/userInvitationCancel.js.map +0 -1
  656. package/dist/examples/userList.d.ts +0 -1
  657. package/dist/examples/userList.js +0 -29
  658. package/dist/examples/userList.js.map +0 -1
  659. package/dist/examples/userResendInvitation.d.ts +0 -1
  660. package/dist/examples/userResendInvitation.js +0 -28
  661. package/dist/examples/userResendInvitation.js.map +0 -1
  662. package/dist/examples/userUpdateRole.d.ts +0 -1
  663. package/dist/examples/userUpdateRole.js +0 -31
  664. package/dist/examples/userUpdateRole.js.map +0 -1
  665. package/dist/tests/config.d.ts +0 -5
  666. package/dist/tests/config.js +0 -43
  667. package/dist/tests/config.js.map +0 -1
  668. package/dist/tests/integration/BrandingApiTest.spec.d.ts +0 -1
  669. package/dist/tests/integration/BrandingApiTest.spec.js +0 -310
  670. package/dist/tests/integration/BrandingApiTest.spec.js.map +0 -1
  671. package/dist/tests/integration/ContactsApiTest.spec.d.ts +0 -1
  672. package/dist/tests/integration/ContactsApiTest.spec.js +0 -249
  673. package/dist/tests/integration/ContactsApiTest.spec.js.map +0 -1
  674. package/dist/tests/integration/CustomFieldApiTest.spec.d.ts +0 -1
  675. package/dist/tests/integration/CustomFieldApiTest.spec.js +0 -289
  676. package/dist/tests/integration/CustomFieldApiTest.spec.js.map +0 -1
  677. package/dist/tests/integration/DocumentApiTest.spec.d.ts +0 -1
  678. package/dist/tests/integration/DocumentApiTest.spec.js +0 -1710
  679. package/dist/tests/integration/DocumentApiTest.spec.js.map +0 -1
  680. package/dist/tests/integration/IdentityVerificationApiTest.spec.d.ts +0 -1
  681. package/dist/tests/integration/IdentityVerificationApiTest.spec.js +0 -160
  682. package/dist/tests/integration/IdentityVerificationApiTest.spec.js.map +0 -1
  683. package/dist/tests/integration/TemplateApiTest.spec.d.ts +0 -1
  684. package/dist/tests/integration/TemplateApiTest.spec.js +0 -1518
  685. package/dist/tests/integration/TemplateApiTest.spec.js.map +0 -1
  686. package/dist/tests/integration/planApiTest.spec.d.ts +0 -1
  687. package/dist/tests/integration/planApiTest.spec.js +0 -41
  688. package/dist/tests/integration/planApiTest.spec.js.map +0 -1
  689. package/dist/tests/integration/senderIdentity.spec.d.ts +0 -1
  690. package/dist/tests/integration/senderIdentity.spec.js +0 -481
  691. package/dist/tests/integration/senderIdentity.spec.js.map +0 -1
  692. package/dist/tests/integration/teamsApiTest.spec.d.ts +0 -1
  693. package/dist/tests/integration/teamsApiTest.spec.js +0 -230
  694. package/dist/tests/integration/teamsApiTest.spec.js.map +0 -1
  695. package/dist/tests/integration/usersApiTest.spec.d.ts +0 -1
  696. package/dist/tests/integration/usersApiTest.spec.js +0 -290
  697. package/dist/tests/integration/usersApiTest.spec.js.map +0 -1
  698. package/dist/tests/performance/performanceApiTest.spec.d.ts +0 -1
  699. package/dist/tests/performance/performanceApiTest.spec.js +0 -368
  700. package/dist/tests/performance/performanceApiTest.spec.js.map +0 -1
  701. package/dist/tests/unit/brandingApi.spec.d.ts +0 -1
  702. package/dist/tests/unit/brandingApi.spec.js +0 -174
  703. package/dist/tests/unit/brandingApi.spec.js.map +0 -1
  704. package/dist/tests/unit/contactsApi.spec.d.ts +0 -1
  705. package/dist/tests/unit/contactsApi.spec.js +0 -154
  706. package/dist/tests/unit/contactsApi.spec.js.map +0 -1
  707. package/dist/tests/unit/customFieldApi.spec.d.ts +0 -1
  708. package/dist/tests/unit/customFieldApi.spec.js +0 -140
  709. package/dist/tests/unit/customFieldApi.spec.js.map +0 -1
  710. package/dist/tests/unit/documentApi.spec.d.ts +0 -1
  711. package/dist/tests/unit/documentApi.spec.js +0 -476
  712. package/dist/tests/unit/documentApi.spec.js.map +0 -1
  713. package/dist/tests/unit/planApi.spec.d.ts +0 -1
  714. package/dist/tests/unit/planApi.spec.js +0 -69
  715. package/dist/tests/unit/planApi.spec.js.map +0 -1
  716. package/dist/tests/unit/senderIdentitiesApi.spec.d.ts +0 -1
  717. package/dist/tests/unit/senderIdentitiesApi.spec.js +0 -148
  718. package/dist/tests/unit/senderIdentitiesApi.spec.js.map +0 -1
  719. package/dist/tests/unit/teamApi.spec.d.ts +0 -1
  720. package/dist/tests/unit/teamApi.spec.js +0 -116
  721. package/dist/tests/unit/teamApi.spec.js.map +0 -1
  722. package/dist/tests/unit/templateApi.spec.d.ts +0 -1
  723. package/dist/tests/unit/templateApi.spec.js +0 -285
  724. package/dist/tests/unit/templateApi.spec.js.map +0 -1
  725. package/dist/tests/unit/userApi.spec.d.ts +0 -1
  726. package/dist/tests/unit/userApi.spec.js +0 -163
  727. package/dist/tests/unit/userApi.spec.js.map +0 -1
  728. package/examples/DocumentProperties.ts +0 -15
  729. package/examples/brandCreate.ts +0 -29
  730. package/examples/brandDelete.ts +0 -15
  731. package/examples/brandGet.ts +0 -15
  732. package/examples/brandList.ts +0 -14
  733. package/examples/brandResetDefault.ts +0 -15
  734. package/examples/brandUpdate.ts +0 -21
  735. package/examples/contactCreate.ts +0 -26
  736. package/examples/contactDelete.ts +0 -15
  737. package/examples/contactGet.ts +0 -15
  738. package/examples/contactGroupDelete.ts +0 -14
  739. package/examples/contactGroupGet.ts +0 -14
  740. package/examples/contactGroupList.ts +0 -16
  741. package/examples/contactGroupUpdate.ts +0 -21
  742. package/examples/contactGroupsCreate.ts +0 -24
  743. package/examples/contactList.ts +0 -16
  744. package/examples/contactUpdate.ts +0 -26
  745. package/examples/customFieldCreate.ts +0 -28
  746. package/examples/customFieldDelete.ts +0 -15
  747. package/examples/customFieldEdit.ts +0 -30
  748. package/examples/customFieldEmbeddedCreateUrl.ts +0 -19
  749. package/examples/customFieldList.ts +0 -15
  750. package/examples/documentAddAuthentication.ts +0 -20
  751. package/examples/documentAddTags.ts +0 -19
  752. package/examples/documentCancelEditing.ts +0 -14
  753. package/examples/documentChangeAccessCode.ts +0 -20
  754. package/examples/documentChangeRecipients.ts +0 -22
  755. package/examples/documentCreateEmbeddedEditUrl.ts +0 -19
  756. package/examples/documentDelete.ts +0 -16
  757. package/examples/documentDeleteTags.ts +0 -19
  758. package/examples/documentDownload.ts +0 -16
  759. package/examples/documentDownloadAttachment.ts +0 -17
  760. package/examples/documentDownloadAuditTrial.ts +0 -16
  761. package/examples/documentEdit.ts +0 -43
  762. package/examples/documentEmbeddedRequestLink.ts +0 -49
  763. package/examples/documentEmbeddedSignLink.ts +0 -23
  764. package/examples/documentExtendExpiry.ts +0 -20
  765. package/examples/documentList.ts +0 -19
  766. package/examples/documentListBehalf.ts +0 -15
  767. package/examples/documentListTeam.ts +0 -15
  768. package/examples/documentPrefillFieldCheckBox.ts +0 -23
  769. package/examples/documentPrefillFieldDropDown.ts +0 -23
  770. package/examples/documentPrefillFieldEditableDate.ts +0 -23
  771. package/examples/documentPrefillFieldImage.ts +0 -23
  772. package/examples/documentPrefillFieldRadioButton.ts +0 -23
  773. package/examples/documentPrefillFieldTextBox.ts +0 -23
  774. package/examples/documentRemoveAuthentication.ts +0 -19
  775. package/examples/documentRevoke.ts +0 -19
  776. package/examples/documentSend.ts +0 -51
  777. package/examples/documentSendOnBehalf.ts +0 -53
  778. package/examples/documentSendReminder.ts +0 -20
  779. package/examples/documents/agreement.pdf +0 -0
  780. package/examples/documents/logo.jpg +0 -0
  781. package/examples/draftSend.ts +0 -12
  782. package/examples/embeddedCreatePreviewUrl.ts +0 -15
  783. package/examples/embeddedManualVerification.ts +0 -22
  784. package/examples/identityVerificationImage.ts +0 -23
  785. package/examples/identityVerificationReport.ts +0 -21
  786. package/examples/listTemplate.ts +0 -16
  787. package/examples/plan.ts +0 -14
  788. package/examples/senderIdentityCreate.ts +0 -21
  789. package/examples/senderIdentityDelete.ts +0 -15
  790. package/examples/senderIdentityList.ts +0 -16
  791. package/examples/senderIdentityProperties.ts +0 -15
  792. package/examples/senderIdentityRerequest.ts +0 -15
  793. package/examples/senderIdentityResendInvitation.ts +0 -15
  794. package/examples/senderIdentityUpdate.ts +0 -20
  795. package/examples/teamCreate.ts +0 -18
  796. package/examples/teamGet.ts +0 -15
  797. package/examples/teamList.ts +0 -16
  798. package/examples/teamUpdate.ts +0 -19
  799. package/examples/templateAddTag.ts +0 -20
  800. package/examples/templateCreate.ts +0 -47
  801. package/examples/templateDelete.ts +0 -15
  802. package/examples/templateDeleteTag.ts +0 -20
  803. package/examples/templateDetails.ts +0 -15
  804. package/examples/templateDownload.ts +0 -15
  805. package/examples/templateEdit.ts +0 -28
  806. package/examples/templateEmbeddedCreate.ts +0 -29
  807. package/examples/templateEmbeddedEdit.ts +0 -24
  808. package/examples/templateEmbeddedRequestLink.ts +0 -34
  809. package/examples/templateMergerEmbeddedRequestUrl.ts +0 -37
  810. package/examples/templateSendDocument.ts +0 -60
  811. package/examples/templateSendDocumentUsingMultipleTemplate.ts +0 -40
  812. package/examples/userChangeTeam.ts +0 -15
  813. package/examples/userCreate.ts +0 -20
  814. package/examples/userGet.ts +0 -15
  815. package/examples/userInvitationCancel.ts +0 -15
  816. package/examples/userList.ts +0 -16
  817. package/examples/userResendInvitation.ts +0 -15
  818. package/examples/userUpdateRole.ts +0 -19
  819. package/tests/config.ts +0 -20
  820. package/tests/documents/agreement.pdf +0 -0
  821. package/tests/documents/logo.jpg +0 -0
  822. package/tests/integration/BrandingApiTest.spec.ts +0 -254
  823. package/tests/integration/ContactsApiTest.spec.ts +0 -222
  824. package/tests/integration/CustomFieldApiTest.spec.ts +0 -231
  825. package/tests/integration/DocumentApiTest.spec.ts +0 -1624
  826. package/tests/integration/IdentityVerificationApiTest.spec.ts +0 -114
  827. package/tests/integration/TemplateApiTest.spec.ts +0 -1420
  828. package/tests/integration/planApiTest.spec.ts +0 -26
  829. package/tests/integration/senderIdentity.spec.ts +0 -397
  830. package/tests/integration/teamsApiTest.spec.ts +0 -226
  831. package/tests/integration/usersApiTest.spec.ts +0 -251
  832. package/tests/performance/performanceApiTest.spec.ts +0 -362
  833. package/tests/unit/brandingApi.spec.ts +0 -163
  834. package/tests/unit/contactsApi.spec.ts +0 -143
  835. package/tests/unit/customFieldApi.spec.ts +0 -123
  836. package/tests/unit/documentApi.spec.ts +0 -545
  837. package/tests/unit/planApi.spec.ts +0 -34
  838. package/tests/unit/senderIdentitiesApi.spec.ts +0 -148
  839. package/tests/unit/teamApi.spec.ts +0 -94
  840. package/tests/unit/templateApi.spec.ts +0 -307
  841. package/tests/unit/userApi.spec.ts +0 -162
package/docs/TemplateApi.md CHANGED
@@ -1,520 +1,554 @@
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
- | [**createEmbeddedPreviewUrl()**](TemplateApi.md#createEmbeddedPreviewUrl) | **POST** /v1/template/createEmbeddedPreviewUrl | Generates a preview URL for a template to view it. |
9
- | [**createEmbeddedRequestUrlTemplate()**](TemplateApi.md#createEmbeddedRequestUrlTemplate) | **POST** /v1/template/createEmbeddedRequestUrl | Generates a send URL using a template which embeds document sending process into your application. |
10
- | [**createEmbeddedTemplateUrl()**](TemplateApi.md#createEmbeddedTemplateUrl) | **POST** /v1/template/createEmbeddedTemplateUrl | Generates a create URL to embeds template create process into your application. |
11
- | [**createTemplate()**](TemplateApi.md#createTemplate) | **POST** /v1/template/create | Creates a new template. |
12
- | [**deleteTemplate()**](TemplateApi.md#deleteTemplate) | **DELETE** /v1/template/delete | Deletes a template. |
13
- | [**deleteTag()**](TemplateApi.md#deleteTag) | **DELETE** /v1/template/deleteTags | Delete the Tags in Templates. |
14
- | [**download()**](TemplateApi.md#download) | **GET** /v1/template/download | Download the template. |
15
- | [**editTemplate()**](TemplateApi.md#editTemplate) | **PUT** /v1/template/edit | Edit and updates an existing template. |
16
- | [**getEmbeddedTemplateEditUrl()**](TemplateApi.md#getEmbeddedTemplateEditUrl) | **POST** /v1/template/getEmbeddedTemplateEditUrl | Generates a edit URL to embeds template edit process into your application. |
17
- | [**getProperties()**](TemplateApi.md#getProperties) | **GET** /v1/template/properties | Get summary of the template. |
18
- | [**listTemplates()**](TemplateApi.md#listTemplates) | **GET** /v1/template/list | List all the templates. |
19
- | [**mergeAndSend()**](TemplateApi.md#mergeAndSend) | **POST** /v1/template/mergeAndSend | Send the document by merging multiple templates. |
20
- | [**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. |
21
- | [**sendUsingTemplate()**](TemplateApi.md#sendUsingTemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
22
-
23
-
24
- ## `addTag()`
25
-
26
- ```typescript
27
- addTag(templateTag: TemplateTag)
28
- ```
29
-
30
- Add the Tags in Templates.
31
-
32
-
33
- ### Parameters
34
-
35
- |Name | Type | Description | Notes |
36
- | ------------- | ------------- | ------------- | ------------- |
37
- | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| ContainsTemplateId and Label Names for AddingTags. | [optional] |
38
-
39
- ### Return type
40
-
41
- void (empty response body)
42
-
43
- ### Authorization
44
-
45
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
46
-
47
- ### HTTP request headers
48
-
49
- - **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`
50
- - **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`
51
-
52
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
53
- [[Back to Model list]](../README.md#models)
54
- [[Back to README]](../README.md)
55
-
56
- ## `createEmbeddedPreviewUrl()`
57
-
58
- ```typescript
59
- createEmbeddedPreviewUrl(templateId: string, embeddedTemplatePreviewJsonRequest: EmbeddedTemplatePreviewJsonRequest): EmbeddedTemplatePreview
60
- ```
61
-
62
- Generates a preview URL for a template to view it.
63
-
64
-
65
- ### Parameters
66
-
67
- |Name | Type | Description | Notes |
68
- | ------------- | ------------- | ------------- | ------------- |
69
- | **templateId** | **string**| The template id. | |
70
- | **embeddedTemplatePreviewJsonRequest** | [**EmbeddedTemplatePreviewJsonRequest**](../docs/EmbeddedTemplatePreviewJsonRequest.md)| The embedded template preview request body. | [optional] |
71
-
72
- ### Return type
73
-
74
- [**EmbeddedTemplatePreview**](../docs/EmbeddedTemplatePreview.md)
75
-
76
- ### Authorization
77
-
78
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
79
-
80
- ### HTTP request headers
81
-
82
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
83
- - **Accept**: `application/json`
84
-
85
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
86
- [[Back to Model list]](../README.md#models)
87
- [[Back to README]](../README.md)
88
-
89
- ## `createEmbeddedRequestUrlTemplate()`
90
-
91
- ```typescript
92
- createEmbeddedRequestUrlTemplate(templateId: string, embeddedSendTemplateFormRequest: EmbeddedSendTemplateFormRequest): EmbeddedSendCreated
93
- ```
94
-
95
- Generates a send URL using a template which embeds document sending process into your application.
96
-
97
-
98
- ### Parameters
99
-
100
- |Name | Type | Description | Notes |
101
- | ------------- | ------------- | ------------- | ------------- |
102
- | **templateId** | **string**| The template id. | |
103
- | **embeddedSendTemplateFormRequest** | [**EmbeddedSendTemplateFormRequest**](../docs/EmbeddedSendTemplateFormRequest.md)| Embedded send template json request. | [optional] |
104
-
105
- ### Return type
106
-
107
- [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
108
-
109
- ### Authorization
110
-
111
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
112
-
113
- ### HTTP request headers
114
-
115
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
116
- - **Accept**: `application/json`
117
-
118
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
119
- [[Back to Model list]](../README.md#models)
120
- [[Back to README]](../README.md)
121
-
122
- ## `createEmbeddedTemplateUrl()`
123
-
124
- ```typescript
125
- createEmbeddedTemplateUrl(embeddedCreateTemplateRequest: EmbeddedCreateTemplateRequest): EmbeddedTemplateCreated
126
- ```
127
-
128
- Generates a create URL to embeds template create process into your application.
129
-
130
-
131
- ### Parameters
132
-
133
- |Name | Type | Description | Notes |
134
- | ------------- | ------------- | ------------- | ------------- |
135
- | **embeddedCreateTemplateRequest** | [**EmbeddedCreateTemplateRequest**](../docs/EmbeddedCreateTemplateRequest.md)| The create embedded template request body. | [optional] |
136
-
137
- ### Return type
138
-
139
- [**EmbeddedTemplateCreated**](../docs/EmbeddedTemplateCreated.md)
140
-
141
- ### Authorization
142
-
143
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
144
-
145
- ### HTTP request headers
146
-
147
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
148
- - **Accept**: `application/json`
149
-
150
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
151
- [[Back to Model list]](../README.md#models)
152
- [[Back to README]](../README.md)
153
-
154
- ## `createTemplate()`
155
-
156
- ```typescript
157
- createTemplate(createTemplateRequest: CreateTemplateRequest): TemplateCreated
158
- ```
159
-
160
- Creates a new template.
161
-
162
-
163
- ### Parameters
164
-
165
- |Name | Type | Description | Notes |
166
- | ------------- | ------------- | ------------- | ------------- |
167
- | **createTemplateRequest** | [**CreateTemplateRequest**](../docs/CreateTemplateRequest.md)| The create template request body. | [optional] |
168
-
169
- ### Return type
170
-
171
- [**TemplateCreated**](../docs/TemplateCreated.md)
172
-
173
- ### Authorization
174
-
175
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
176
-
177
- ### HTTP request headers
178
-
179
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
180
- - **Accept**: `application/json`
181
-
182
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
183
- [[Back to Model list]](../README.md#models)
184
- [[Back to README]](../README.md)
185
-
186
- ## `deleteTemplate()`
187
-
188
- ```typescript
189
- deleteTemplate(templateId: string, onBehalfOf: string)
190
- ```
191
-
192
- Deletes a template.
193
-
194
-
195
- ### Parameters
196
-
197
- |Name | Type | Description | Notes |
198
- | ------------- | ------------- | ------------- | ------------- |
199
- | **templateId** | **string**| The template id. | |
200
- | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
201
-
202
- ### Return type
203
-
204
- void (empty response body)
205
-
206
- ### Authorization
207
-
208
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
209
-
210
- ### HTTP request headers
211
-
212
- - **Content-Type**: Not defined
213
- - **Accept**: `application/json`
214
-
215
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
216
- [[Back to Model list]](../README.md#models)
217
- [[Back to README]](../README.md)
218
-
219
- ## `deleteTag()`
220
-
221
- ```typescript
222
- deleteTag(templateTag: TemplateTag)
223
- ```
224
-
225
- Delete the Tags in Templates.
226
-
227
-
228
- ### Parameters
229
-
230
- |Name | Type | Description | Notes |
231
- | ------------- | ------------- | ------------- | ------------- |
232
- | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| Contains TemplateId and LabelNames for Adding Tags. | [optional] |
233
-
234
- ### Return type
235
-
236
- void (empty response body)
237
-
238
- ### Authorization
239
-
240
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
241
-
242
- ### HTTP request headers
243
-
244
- - **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`
245
- - **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`
246
-
247
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
248
- [[Back to Model list]](../README.md#models)
249
- [[Back to README]](../README.md)
250
-
251
- ## `download()`
252
-
253
- ```typescript
254
- download(templateId: string, onBehalfOf: string, includeFormFieldValues: boolean): Buffer
255
- ```
256
-
257
- Download the template.
258
-
259
-
260
- ### Parameters
261
-
262
- |Name | Type | Description | Notes |
263
- | ------------- | ------------- | ------------- | ------------- |
264
- | **templateId** | **string**| Template Id. | |
265
- | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
266
- | **includeFormFieldValues** | **boolean**| Include form field data. | [optional] [default to false] |
267
-
268
- ### Return type
269
-
270
- **Buffer**
271
-
272
- ### Authorization
273
-
274
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
275
-
276
- ### HTTP request headers
277
-
278
- - **Content-Type**: Not defined
279
- - **Accept**: `application/json`
280
-
281
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
282
- [[Back to Model list]](../README.md#models)
283
- [[Back to README]](../README.md)
284
-
285
- ## `editTemplate()`
286
-
287
- ```typescript
288
- editTemplate(templateId: string, editTemplateRequest: EditTemplateRequest)
289
- ```
290
-
291
- Edit and updates an existing template.
292
-
293
-
294
- ### Parameters
295
-
296
- |Name | Type | Description | Notes |
297
- | ------------- | ------------- | ------------- | ------------- |
298
- | **templateId** | **string**| The template id. | |
299
- | **editTemplateRequest** | [**EditTemplateRequest**](../docs/EditTemplateRequest.md)| The edit template request body. | |
300
-
301
- ### Return type
302
-
303
- void (empty response body)
304
-
305
- ### Authorization
306
-
307
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
308
-
309
- ### HTTP request headers
310
-
311
- - **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`
312
- - **Accept**: `application/json`
313
-
314
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
315
- [[Back to Model list]](../README.md#models)
316
- [[Back to README]](../README.md)
317
-
318
- ## `getEmbeddedTemplateEditUrl()`
319
-
320
- ```typescript
321
- getEmbeddedTemplateEditUrl(templateId: string, embeddedTemplateEditRequest: EmbeddedTemplateEditRequest): EmbeddedTemplateEdited
322
- ```
323
-
324
- Generates a edit URL to embeds template edit process into your application.
325
-
326
-
327
- ### Parameters
328
-
329
- |Name | Type | Description | Notes |
330
- | ------------- | ------------- | ------------- | ------------- |
331
- | **templateId** | **string**| The template id. | |
332
- | **embeddedTemplateEditRequest** | [**EmbeddedTemplateEditRequest**](../docs/EmbeddedTemplateEditRequest.md)| The embedded edit template request body. | [optional] |
333
-
334
- ### Return type
335
-
336
- [**EmbeddedTemplateEdited**](../docs/EmbeddedTemplateEdited.md)
337
-
338
- ### Authorization
339
-
340
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
341
-
342
- ### HTTP request headers
343
-
344
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
345
- - **Accept**: `application/json`
346
-
347
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
348
- [[Back to Model list]](../README.md#models)
349
- [[Back to README]](../README.md)
350
-
351
- ## `getProperties()`
352
-
353
- ```typescript
354
- getProperties(templateId: string): TemplateProperties
355
- ```
356
-
357
- Get summary of the template.
358
-
359
-
360
- ### Parameters
361
-
362
- |Name | Type | Description | Notes |
363
- | ------------- | ------------- | ------------- | ------------- |
364
- | **templateId** | **string**| Template Id. | |
365
-
366
- ### Return type
367
-
368
- [**TemplateProperties**](../docs/TemplateProperties.md)
369
-
370
- ### Authorization
371
-
372
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
373
-
374
- ### HTTP request headers
375
-
376
- - **Content-Type**: Not defined
377
- - **Accept**: `application/json`
378
-
379
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
380
- [[Back to Model list]](../README.md#models)
381
- [[Back to README]](../README.md)
382
-
383
- ## `listTemplates()`
384
-
385
- ```typescript
386
- 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>, sharedWithTeamId: Array<string>): TemplateRecords
387
- ```
388
-
389
- List all the templates.
390
-
391
-
392
- ### Parameters
393
-
394
- |Name | Type | Description | Notes |
395
- | ------------- | ------------- | ------------- | ------------- |
396
- | **page** | **number**| | [default to 1] |
397
- | **templateType** | **'mytemplates' | 'sharedtemplate' | 'all'**| | [optional] |
398
- | **pageSize** | **number**| | [optional] [default to 10] |
399
- | **searchKey** | **string**| | [optional] |
400
- | **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] |
401
- | **createdBy** | [**Array<string>**](../docs/string.md)| The templates can be listed by the creator of the template. | [optional] |
402
- | **templateLabels** | [**Array<string>**](../docs/string.md)| Labels of the template. | [optional] |
403
- | **startDate** | **Date**| Start date of the template | [optional] |
404
- | **endDate** | **Date**| End date of the template | [optional] |
405
- | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the template. | [optional] |
406
- | **sharedWithTeamId** | [**Array<string>**](../docs/string.md)| The templates can be listed by the shared teams. | [optional] |
407
-
408
- ### Return type
409
-
410
- [**TemplateRecords**](../docs/TemplateRecords.md)
411
-
412
- ### Authorization
413
-
414
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
415
-
416
- ### HTTP request headers
417
-
418
- - **Content-Type**: Not defined
419
- - **Accept**: `application/json`
420
-
421
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
422
- [[Back to Model list]](../README.md#models)
423
- [[Back to README]](../README.md)
424
-
425
- ## `mergeAndSend()`
426
-
427
- ```typescript
428
- mergeAndSend(mergeAndSendForSignForm: MergeAndSendForSignForm): DocumentCreated
429
- ```
430
-
431
- Send the document by merging multiple templates.
432
-
433
-
434
- ### Parameters
435
-
436
- |Name | Type | Description | Notes |
437
- | ------------- | ------------- | ------------- | ------------- |
438
- | **mergeAndSendForSignForm** | [**MergeAndSendForSignForm**](../docs/MergeAndSendForSignForm.md)| The merge and send details as JSON. | [optional] |
439
-
440
- ### Return type
441
-
442
- [**DocumentCreated**](../docs/DocumentCreated.md)
443
-
444
- ### Authorization
445
-
446
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
447
-
448
- ### HTTP request headers
449
-
450
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
451
- - **Accept**: `application/json`
452
-
453
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
454
- [[Back to Model list]](../README.md#models)
455
- [[Back to README]](../README.md)
456
-
457
- ## `mergeCreateEmbeddedRequestUrlTemplate()`
458
-
459
- ```typescript
460
- mergeCreateEmbeddedRequestUrlTemplate(embeddedMergeTemplateFormRequest: EmbeddedMergeTemplateFormRequest): EmbeddedSendCreated
461
- ```
462
-
463
- Generates a merge request URL using a template that combines document merging and sending processes into your application.
464
-
465
-
466
- ### Parameters
467
-
468
- |Name | Type | Description | Notes |
469
- | ------------- | ------------- | ------------- | ------------- |
470
- | **embeddedMergeTemplateFormRequest** | [**EmbeddedMergeTemplateFormRequest**](../docs/EmbeddedMergeTemplateFormRequest.md)| Embedded merge and send template json request. | [optional] |
471
-
472
- ### Return type
473
-
474
- [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
475
-
476
- ### Authorization
477
-
478
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
479
-
480
- ### HTTP request headers
481
-
482
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
483
- - **Accept**: `application/json`
484
-
485
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
486
- [[Back to Model list]](../README.md#models)
487
- [[Back to README]](../README.md)
488
-
489
- ## `sendUsingTemplate()`
490
-
491
- ```typescript
492
- sendUsingTemplate(templateId: string, sendForSignFromTemplateForm: SendForSignFromTemplateForm): DocumentCreated
493
- ```
494
-
495
- Send a document for signature using a Template.
496
-
497
-
498
- ### Parameters
499
-
500
- |Name | Type | Description | Notes |
501
- | ------------- | ------------- | ------------- | ------------- |
502
- | **templateId** | **string**| The template id. | |
503
- | **sendForSignFromTemplateForm** | [**SendForSignFromTemplateForm**](../docs/SendForSignFromTemplateForm.md)| The send template details as JSON. | [optional] |
504
-
505
- ### Return type
506
-
507
- [**DocumentCreated**](../docs/DocumentCreated.md)
508
-
509
- ### Authorization
510
-
511
- [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
512
-
513
- ### HTTP request headers
514
-
515
- - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
516
- - **Accept**: `application/json`
517
-
518
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
519
- [[Back to Model list]](../README.md#models)
520
- [[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
+ | [**createEmbeddedPreviewUrl()**](TemplateApi.md#createEmbeddedPreviewUrl) | **POST** /v1/template/createEmbeddedPreviewUrl | Generates a preview URL for a template to view it. |
9
+ | [**createEmbeddedRequestUrlTemplate()**](TemplateApi.md#createEmbeddedRequestUrlTemplate) | **POST** /v1/template/createEmbeddedRequestUrl | Generates a send URL using a template which embeds document sending process into your application. |
10
+ | [**createEmbeddedTemplateUrl()**](TemplateApi.md#createEmbeddedTemplateUrl) | **POST** /v1/template/createEmbeddedTemplateUrl | Generates a create URL to embeds template create process into your application. |
11
+ | [**createTemplate()**](TemplateApi.md#createTemplate) | **POST** /v1/template/create | Creates a new template. |
12
+ | [**deleteTemplate()**](TemplateApi.md#deleteTemplate) | **DELETE** /v1/template/delete | Deletes a template. |
13
+ | [**deleteTag()**](TemplateApi.md#deleteTag) | **DELETE** /v1/template/deleteTags | Delete the Tags in Templates. |
14
+ | [**download()**](TemplateApi.md#download) | **GET** /v1/template/download | Download the template. |
15
+ | [**editTemplate()**](TemplateApi.md#editTemplate) | **PUT** /v1/template/edit | Edit and updates an existing template. |
16
+ | [**getEmbeddedTemplateEditUrl()**](TemplateApi.md#getEmbeddedTemplateEditUrl) | **POST** /v1/template/getEmbeddedTemplateEditUrl | Generates a edit URL to embeds template edit process into your application. |
17
+ | [**getProperties()**](TemplateApi.md#getProperties) | **GET** /v1/template/properties | Get summary of the template. |
18
+ | [**listTemplates()**](TemplateApi.md#listTemplates) | **GET** /v1/template/list | List all the templates. |
19
+ | [**mergeAndSend()**](TemplateApi.md#mergeAndSend) | **POST** /v1/template/mergeAndSend | Send the document by merging multiple templates. |
20
+ | [**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. |
21
+ | [**sendUsingTemplate()**](TemplateApi.md#sendUsingTemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
22
+ | [**shareTemplate()**](TemplateApi.md#shareTemplate) | **PATCH** /v1/template/share | Share a template with teams and manage permissions. |
23
+
24
+
25
+ ## `addTag()`
26
+
27
+ ```typescript
28
+ addTag(templateTag: TemplateTag)
29
+ ```
30
+
31
+ Add the Tags in Templates.
32
+
33
+
34
+ ### Parameters
35
+
36
+ |Name | Type | Description | Notes |
37
+ | ------------- | ------------- | ------------- | ------------- |
38
+ | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| ContainsTemplateId and Label Names for AddingTags. | [optional] |
39
+
40
+ ### Return type
41
+
42
+ void (empty response body)
43
+
44
+ ### Authorization
45
+
46
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
47
+
48
+ ### HTTP request headers
49
+
50
+ - **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`
51
+ - **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`
52
+
53
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
54
+ [[Back to Model list]](../README.md#models)
55
+ [[Back to README]](../README.md)
56
+
57
+ ## `createEmbeddedPreviewUrl()`
58
+
59
+ ```typescript
60
+ createEmbeddedPreviewUrl(templateId: string, embeddedTemplatePreviewJsonRequest: EmbeddedTemplatePreviewJsonRequest): EmbeddedTemplatePreview
61
+ ```
62
+
63
+ Generates a preview URL for a template to view it.
64
+
65
+
66
+ ### Parameters
67
+
68
+ |Name | Type | Description | Notes |
69
+ | ------------- | ------------- | ------------- | ------------- |
70
+ | **templateId** | **string**| The template id. | |
71
+ | **embeddedTemplatePreviewJsonRequest** | [**EmbeddedTemplatePreviewJsonRequest**](../docs/EmbeddedTemplatePreviewJsonRequest.md)| The embedded template preview request body. | [optional] |
72
+
73
+ ### Return type
74
+
75
+ [**EmbeddedTemplatePreview**](../docs/EmbeddedTemplatePreview.md)
76
+
77
+ ### Authorization
78
+
79
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
84
+ - **Accept**: `application/json`
85
+
86
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
87
+ [[Back to Model list]](../README.md#models)
88
+ [[Back to README]](../README.md)
89
+
90
+ ## `createEmbeddedRequestUrlTemplate()`
91
+
92
+ ```typescript
93
+ createEmbeddedRequestUrlTemplate(templateId: string, embeddedSendTemplateFormRequest: EmbeddedSendTemplateFormRequest): EmbeddedSendCreated
94
+ ```
95
+
96
+ Generates a send URL using a template which embeds document sending process into your application.
97
+
98
+
99
+ ### Parameters
100
+
101
+ |Name | Type | Description | Notes |
102
+ | ------------- | ------------- | ------------- | ------------- |
103
+ | **templateId** | **string**| The template id. | |
104
+ | **embeddedSendTemplateFormRequest** | [**EmbeddedSendTemplateFormRequest**](../docs/EmbeddedSendTemplateFormRequest.md)| Embedded send template json request. | [optional] |
105
+
106
+ ### Return type
107
+
108
+ [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
109
+
110
+ ### Authorization
111
+
112
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
113
+
114
+ ### HTTP request headers
115
+
116
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
117
+ - **Accept**: `application/json`
118
+
119
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
120
+ [[Back to Model list]](../README.md#models)
121
+ [[Back to README]](../README.md)
122
+
123
+ ## `createEmbeddedTemplateUrl()`
124
+
125
+ ```typescript
126
+ createEmbeddedTemplateUrl(embeddedCreateTemplateRequest: EmbeddedCreateTemplateRequest): EmbeddedTemplateCreated
127
+ ```
128
+
129
+ Generates a create URL to embeds template create process into your application.
130
+
131
+
132
+ ### Parameters
133
+
134
+ |Name | Type | Description | Notes |
135
+ | ------------- | ------------- | ------------- | ------------- |
136
+ | **embeddedCreateTemplateRequest** | [**EmbeddedCreateTemplateRequest**](../docs/EmbeddedCreateTemplateRequest.md)| The create embedded template request body. | [optional] |
137
+
138
+ ### Return type
139
+
140
+ [**EmbeddedTemplateCreated**](../docs/EmbeddedTemplateCreated.md)
141
+
142
+ ### Authorization
143
+
144
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
145
+
146
+ ### HTTP request headers
147
+
148
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
149
+ - **Accept**: `application/json`
150
+
151
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
152
+ [[Back to Model list]](../README.md#models)
153
+ [[Back to README]](../README.md)
154
+
155
+ ## `createTemplate()`
156
+
157
+ ```typescript
158
+ createTemplate(createTemplateRequest: CreateTemplateRequest): TemplateCreated
159
+ ```
160
+
161
+ Creates a new template.
162
+
163
+
164
+ ### Parameters
165
+
166
+ |Name | Type | Description | Notes |
167
+ | ------------- | ------------- | ------------- | ------------- |
168
+ | **createTemplateRequest** | [**CreateTemplateRequest**](../docs/CreateTemplateRequest.md)| The create template request body. | [optional] |
169
+
170
+ ### Return type
171
+
172
+ [**TemplateCreated**](../docs/TemplateCreated.md)
173
+
174
+ ### Authorization
175
+
176
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
177
+
178
+ ### HTTP request headers
179
+
180
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
181
+ - **Accept**: `application/json`
182
+
183
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
184
+ [[Back to Model list]](../README.md#models)
185
+ [[Back to README]](../README.md)
186
+
187
+ ## `deleteTemplate()`
188
+
189
+ ```typescript
190
+ deleteTemplate(templateId: string, onBehalfOf: string)
191
+ ```
192
+
193
+ Deletes a template.
194
+
195
+
196
+ ### Parameters
197
+
198
+ |Name | Type | Description | Notes |
199
+ | ------------- | ------------- | ------------- | ------------- |
200
+ | **templateId** | **string**| The template id. | |
201
+ | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
202
+
203
+ ### Return type
204
+
205
+ void (empty response body)
206
+
207
+ ### Authorization
208
+
209
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
210
+
211
+ ### HTTP request headers
212
+
213
+ - **Content-Type**: Not defined
214
+ - **Accept**: `application/json`
215
+
216
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
217
+ [[Back to Model list]](../README.md#models)
218
+ [[Back to README]](../README.md)
219
+
220
+ ## `deleteTag()`
221
+
222
+ ```typescript
223
+ deleteTag(templateTag: TemplateTag)
224
+ ```
225
+
226
+ Delete the Tags in Templates.
227
+
228
+
229
+ ### Parameters
230
+
231
+ |Name | Type | Description | Notes |
232
+ | ------------- | ------------- | ------------- | ------------- |
233
+ | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| Contains TemplateId and LabelNames for Adding Tags. | [optional] |
234
+
235
+ ### Return type
236
+
237
+ void (empty response body)
238
+
239
+ ### Authorization
240
+
241
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
242
+
243
+ ### HTTP request headers
244
+
245
+ - **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`
246
+ - **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`
247
+
248
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
249
+ [[Back to Model list]](../README.md#models)
250
+ [[Back to README]](../README.md)
251
+
252
+ ## `download()`
253
+
254
+ ```typescript
255
+ download(templateId: string, onBehalfOf: string, includeFormFieldValues: boolean): Buffer
256
+ ```
257
+
258
+ Download the template.
259
+
260
+
261
+ ### Parameters
262
+
263
+ |Name | Type | Description | Notes |
264
+ | ------------- | ------------- | ------------- | ------------- |
265
+ | **templateId** | **string**| Template Id. | |
266
+ | **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
267
+ | **includeFormFieldValues** | **boolean**| Include form field data. | [optional] [default to false] |
268
+
269
+ ### Return type
270
+
271
+ **Buffer**
272
+
273
+ ### Authorization
274
+
275
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
276
+
277
+ ### HTTP request headers
278
+
279
+ - **Content-Type**: Not defined
280
+ - **Accept**: `application/json`
281
+
282
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
283
+ [[Back to Model list]](../README.md#models)
284
+ [[Back to README]](../README.md)
285
+
286
+ ## `editTemplate()`
287
+
288
+ ```typescript
289
+ editTemplate(templateId: string, editTemplateRequest: EditTemplateRequest)
290
+ ```
291
+
292
+ Edit and updates an existing template.
293
+
294
+
295
+ ### Parameters
296
+
297
+ |Name | Type | Description | Notes |
298
+ | ------------- | ------------- | ------------- | ------------- |
299
+ | **templateId** | **string**| The template id. | |
300
+ | **editTemplateRequest** | [**EditTemplateRequest**](../docs/EditTemplateRequest.md)| The edit template request body. | |
301
+
302
+ ### Return type
303
+
304
+ void (empty response body)
305
+
306
+ ### Authorization
307
+
308
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
309
+
310
+ ### HTTP request headers
311
+
312
+ - **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`
313
+ - **Accept**: `application/json`
314
+
315
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
316
+ [[Back to Model list]](../README.md#models)
317
+ [[Back to README]](../README.md)
318
+
319
+ ## `getEmbeddedTemplateEditUrl()`
320
+
321
+ ```typescript
322
+ getEmbeddedTemplateEditUrl(templateId: string, embeddedTemplateEditRequest: EmbeddedTemplateEditRequest): EmbeddedTemplateEdited
323
+ ```
324
+
325
+ Generates a edit URL to embeds template edit process into your application.
326
+
327
+
328
+ ### Parameters
329
+
330
+ |Name | Type | Description | Notes |
331
+ | ------------- | ------------- | ------------- | ------------- |
332
+ | **templateId** | **string**| The template id. | |
333
+ | **embeddedTemplateEditRequest** | [**EmbeddedTemplateEditRequest**](../docs/EmbeddedTemplateEditRequest.md)| The embedded edit template request body. | [optional] |
334
+
335
+ ### Return type
336
+
337
+ [**EmbeddedTemplateEdited**](../docs/EmbeddedTemplateEdited.md)
338
+
339
+ ### Authorization
340
+
341
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
342
+
343
+ ### HTTP request headers
344
+
345
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
346
+ - **Accept**: `application/json`
347
+
348
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
349
+ [[Back to Model list]](../README.md#models)
350
+ [[Back to README]](../README.md)
351
+
352
+ ## `getProperties()`
353
+
354
+ ```typescript
355
+ getProperties(templateId: string): TemplateProperties
356
+ ```
357
+
358
+ Get summary of the template.
359
+
360
+
361
+ ### Parameters
362
+
363
+ |Name | Type | Description | Notes |
364
+ | ------------- | ------------- | ------------- | ------------- |
365
+ | **templateId** | **string**| Template Id. | |
366
+
367
+ ### Return type
368
+
369
+ [**TemplateProperties**](../docs/TemplateProperties.md)
370
+
371
+ ### Authorization
372
+
373
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
374
+
375
+ ### HTTP request headers
376
+
377
+ - **Content-Type**: Not defined
378
+ - **Accept**: `application/json`
379
+
380
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
381
+ [[Back to Model list]](../README.md#models)
382
+ [[Back to README]](../README.md)
383
+
384
+ ## `listTemplates()`
385
+
386
+ ```typescript
387
+ 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>, sharedWithTeamId: Array<string>): TemplateRecords
388
+ ```
389
+
390
+ List all the templates.
391
+
392
+
393
+ ### Parameters
394
+
395
+ |Name | Type | Description | Notes |
396
+ | ------------- | ------------- | ------------- | ------------- |
397
+ | **page** | **number**| | [default to 1] |
398
+ | **templateType** | **'mytemplates' | 'sharedtemplate' | 'all'**| | [optional] |
399
+ | **pageSize** | **number**| | [optional] [default to 10] |
400
+ | **searchKey** | **string**| | [optional] |
401
+ | **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] |
402
+ | **createdBy** | [**Array<string>**](../docs/string.md)| The templates can be listed by the creator of the template. | [optional] |
403
+ | **templateLabels** | [**Array<string>**](../docs/string.md)| Labels of the template. | [optional] |
404
+ | **startDate** | **Date**| Start date of the template | [optional] |
405
+ | **endDate** | **Date**| End date of the template | [optional] |
406
+ | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the template. | [optional] |
407
+ | **sharedWithTeamId** | [**Array<string>**](../docs/string.md)| The templates can be listed by the shared teams. | [optional] |
408
+
409
+ ### Return type
410
+
411
+ [**TemplateRecords**](../docs/TemplateRecords.md)
412
+
413
+ ### Authorization
414
+
415
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
416
+
417
+ ### HTTP request headers
418
+
419
+ - **Content-Type**: Not defined
420
+ - **Accept**: `application/json`
421
+
422
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
423
+ [[Back to Model list]](../README.md#models)
424
+ [[Back to README]](../README.md)
425
+
426
+ ## `mergeAndSend()`
427
+
428
+ ```typescript
429
+ mergeAndSend(mergeAndSendForSignForm: MergeAndSendForSignForm): DocumentCreated
430
+ ```
431
+
432
+ Send the document by merging multiple templates.
433
+
434
+
435
+ ### Parameters
436
+
437
+ |Name | Type | Description | Notes |
438
+ | ------------- | ------------- | ------------- | ------------- |
439
+ | **mergeAndSendForSignForm** | [**MergeAndSendForSignForm**](../docs/MergeAndSendForSignForm.md)| The merge and send details as JSON. | [optional] |
440
+
441
+ ### Return type
442
+
443
+ [**DocumentCreated**](../docs/DocumentCreated.md)
444
+
445
+ ### Authorization
446
+
447
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
448
+
449
+ ### HTTP request headers
450
+
451
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
452
+ - **Accept**: `application/json`
453
+
454
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
455
+ [[Back to Model list]](../README.md#models)
456
+ [[Back to README]](../README.md)
457
+
458
+ ## `mergeCreateEmbeddedRequestUrlTemplate()`
459
+
460
+ ```typescript
461
+ mergeCreateEmbeddedRequestUrlTemplate(embeddedMergeTemplateFormRequest: EmbeddedMergeTemplateFormRequest): EmbeddedSendCreated
462
+ ```
463
+
464
+ Generates a merge request URL using a template that combines document merging and sending processes into your application.
465
+
466
+
467
+ ### Parameters
468
+
469
+ |Name | Type | Description | Notes |
470
+ | ------------- | ------------- | ------------- | ------------- |
471
+ | **embeddedMergeTemplateFormRequest** | [**EmbeddedMergeTemplateFormRequest**](../docs/EmbeddedMergeTemplateFormRequest.md)| Embedded merge and send template json request. | [optional] |
472
+
473
+ ### Return type
474
+
475
+ [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
476
+
477
+ ### Authorization
478
+
479
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
480
+
481
+ ### HTTP request headers
482
+
483
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
484
+ - **Accept**: `application/json`
485
+
486
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
487
+ [[Back to Model list]](../README.md#models)
488
+ [[Back to README]](../README.md)
489
+
490
+ ## `sendUsingTemplate()`
491
+
492
+ ```typescript
493
+ sendUsingTemplate(templateId: string, sendForSignFromTemplateForm: SendForSignFromTemplateForm): DocumentCreated
494
+ ```
495
+
496
+ Send a document for signature using a Template.
497
+
498
+
499
+ ### Parameters
500
+
501
+ |Name | Type | Description | Notes |
502
+ | ------------- | ------------- | ------------- | ------------- |
503
+ | **templateId** | **string**| The template id. | |
504
+ | **sendForSignFromTemplateForm** | [**SendForSignFromTemplateForm**](../docs/SendForSignFromTemplateForm.md)| The send template details as JSON. | [optional] |
505
+
506
+ ### Return type
507
+
508
+ [**DocumentCreated**](../docs/DocumentCreated.md)
509
+
510
+ ### Authorization
511
+
512
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
513
+
514
+ ### HTTP request headers
515
+
516
+ - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
517
+ - **Accept**: `application/json`
518
+
519
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
520
+ [[Back to Model list]](../README.md#models)
521
+ [[Back to README]](../README.md)
522
+
523
+ ## `shareTemplate()`
524
+
525
+ ```typescript
526
+ shareTemplate(templateId: string, templateShareRequest: TemplateShareRequest)
527
+ ```
528
+
529
+ Share a template with teams and manage permissions.
530
+
531
+
532
+ ### Parameters
533
+
534
+ |Name | Type | Description | Notes |
535
+ | ------------- | ------------- | ------------- | ------------- |
536
+ | **templateId** | **string**| Template Id. | |
537
+ | **templateShareRequest** | [**TemplateShareRequest**](../docs/TemplateShareRequest.md)| Permissions request. | |
538
+
539
+ ### Return type
540
+
541
+ void (empty response body)
542
+
543
+ ### Authorization
544
+
545
+ [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
546
+
547
+ ### HTTP request headers
548
+
549
+ - **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`
550
+ - **Accept**: `application/json`
551
+
552
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
553
+ [[Back to Model list]](../README.md#models)
554
+ [[Back to README]](../README.md)