boldsign 1.0.3 → 1.0.4

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