boldsign 1.0.3 → 2.0.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 (533) 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 +1193 -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-2.0.0.tgz +0 -0
  20. package/dist/api/apis.d.ts +1 -1
  21. package/dist/api/apis.js +1 -1
  22. package/dist/api/brandingApi.d.ts +2 -2
  23. package/dist/api/brandingApi.js +10 -4
  24. package/dist/api/brandingApi.js.map +1 -1
  25. package/dist/model/auditTrail.d.ts +3 -1
  26. package/dist/model/auditTrail.js +2 -0
  27. package/dist/model/auditTrail.js.map +1 -1
  28. package/dist/model/collaborationSettings.d.ts +17 -0
  29. package/dist/model/collaborationSettings.js +33 -0
  30. package/dist/model/collaborationSettings.js.map +1 -0
  31. package/dist/model/createTemplateRequest.d.ts +1 -1
  32. package/dist/model/createTemplateRequest.js +5 -5
  33. package/dist/model/createTemplateRequest.js.map +1 -1
  34. package/dist/model/documentFiles.d.ts +1 -0
  35. package/dist/model/documentFiles.js +5 -0
  36. package/dist/model/documentFiles.js.map +1 -1
  37. package/dist/model/documentFormFields.d.ts +4 -0
  38. package/dist/model/documentFormFields.js +15 -0
  39. package/dist/model/documentFormFields.js.map +1 -1
  40. package/dist/model/documentSigner.d.ts +1 -0
  41. package/dist/model/documentSigner.js +5 -0
  42. package/dist/model/documentSigner.js.map +1 -1
  43. package/dist/model/documentSignerDetails.d.ts +1 -0
  44. package/dist/model/documentSignerDetails.js +5 -0
  45. package/dist/model/documentSignerDetails.js.map +1 -1
  46. package/dist/model/embeddedCreateTemplateRequest.d.ts +1 -1
  47. package/dist/model/embeddedCreateTemplateRequest.js +5 -5
  48. package/dist/model/embeddedCreateTemplateRequest.js.map +1 -1
  49. package/dist/model/embeddedDocumentRequest.d.ts +1 -1
  50. package/dist/model/embeddedDocumentRequest.js +5 -5
  51. package/dist/model/embeddedDocumentRequest.js.map +1 -1
  52. package/dist/model/embeddedMergeTemplateFormRequest.d.ts +1 -1
  53. package/dist/model/embeddedMergeTemplateFormRequest.js +5 -5
  54. package/dist/model/embeddedMergeTemplateFormRequest.js.map +1 -1
  55. package/dist/model/embeddedSendTemplateFormRequest.d.ts +1 -1
  56. package/dist/model/embeddedSendTemplateFormRequest.js +5 -5
  57. package/dist/model/embeddedSendTemplateFormRequest.js.map +1 -1
  58. package/dist/model/formField.d.ts +2 -0
  59. package/dist/model/formField.js +5 -0
  60. package/dist/model/formField.js.map +1 -1
  61. package/dist/model/index.d.ts +2 -1
  62. package/dist/model/index.js +6 -3
  63. package/dist/model/index.js.map +1 -1
  64. package/dist/model/mergeAndSendForSignForm.d.ts +1 -1
  65. package/dist/model/mergeAndSendForSignForm.js +5 -5
  66. package/dist/model/mergeAndSendForSignForm.js.map +1 -1
  67. package/dist/model/sendForSign.d.ts +1 -1
  68. package/dist/model/sendForSign.js +5 -5
  69. package/dist/model/sendForSign.js.map +1 -1
  70. package/dist/model/sendForSignFromTemplateForm.d.ts +1 -1
  71. package/dist/model/sendForSignFromTemplateForm.js +5 -5
  72. package/dist/model/sendForSignFromTemplateForm.js.map +1 -1
  73. package/dist/model/templateFormFields.d.ts +2 -0
  74. package/dist/model/templateFormFields.js +5 -0
  75. package/dist/model/templateFormFields.js.map +1 -1
  76. package/dist/model/textTagDefinition.d.ts +2 -0
  77. package/dist/model/textTagDefinition.js +5 -0
  78. package/dist/model/textTagDefinition.js.map +1 -1
  79. package/dist/model/viewBrandDetails.d.ts +1 -0
  80. package/dist/model/viewBrandDetails.js +5 -0
  81. package/dist/model/viewBrandDetails.js.map +1 -1
  82. package/dist/tests/config.d.ts +5 -0
  83. package/dist/tests/config.js +43 -0
  84. package/dist/tests/config.js.map +1 -0
  85. package/dist/tests/integration/BrandingApiTest.spec.d.ts +1 -0
  86. package/dist/tests/integration/BrandingApiTest.spec.js +310 -0
  87. package/dist/tests/integration/BrandingApiTest.spec.js.map +1 -0
  88. package/dist/tests/integration/ContactsApiTest.spec.d.ts +1 -0
  89. package/dist/tests/integration/ContactsApiTest.spec.js +249 -0
  90. package/dist/tests/integration/ContactsApiTest.spec.js.map +1 -0
  91. package/dist/tests/integration/CustomFieldApiTest.spec.d.ts +1 -0
  92. package/dist/tests/integration/CustomFieldApiTest.spec.js +289 -0
  93. package/dist/tests/integration/CustomFieldApiTest.spec.js.map +1 -0
  94. package/dist/tests/integration/DocumentApiTest.spec.d.ts +1 -0
  95. package/dist/tests/integration/DocumentApiTest.spec.js +1710 -0
  96. package/dist/tests/integration/DocumentApiTest.spec.js.map +1 -0
  97. package/dist/tests/integration/IdentityVerificationApiTest.spec.d.ts +1 -0
  98. package/dist/tests/integration/IdentityVerificationApiTest.spec.js +160 -0
  99. package/dist/tests/integration/IdentityVerificationApiTest.spec.js.map +1 -0
  100. package/dist/tests/integration/TemplateApiTest.spec.d.ts +1 -0
  101. package/dist/tests/integration/TemplateApiTest.spec.js +1518 -0
  102. package/dist/tests/integration/TemplateApiTest.spec.js.map +1 -0
  103. package/dist/tests/integration/planApiTest.spec.d.ts +1 -0
  104. package/dist/tests/integration/planApiTest.spec.js +41 -0
  105. package/dist/tests/integration/planApiTest.spec.js.map +1 -0
  106. package/dist/tests/integration/senderIdentity.spec.d.ts +1 -0
  107. package/dist/tests/integration/senderIdentity.spec.js +481 -0
  108. package/dist/tests/integration/senderIdentity.spec.js.map +1 -0
  109. package/dist/tests/integration/teamsApiTest.spec.d.ts +1 -0
  110. package/dist/tests/integration/teamsApiTest.spec.js +230 -0
  111. package/dist/tests/integration/teamsApiTest.spec.js.map +1 -0
  112. package/dist/tests/integration/usersApiTest.spec.d.ts +1 -0
  113. package/dist/tests/integration/usersApiTest.spec.js +290 -0
  114. package/dist/tests/integration/usersApiTest.spec.js.map +1 -0
  115. package/dist/tests/performance/performanceApiTest.spec.d.ts +1 -0
  116. package/dist/tests/performance/performanceApiTest.spec.js +368 -0
  117. package/dist/tests/performance/performanceApiTest.spec.js.map +1 -0
  118. package/dist/tests/unit/brandingApi.spec.d.ts +1 -0
  119. package/dist/tests/unit/brandingApi.spec.js +174 -0
  120. package/dist/tests/unit/brandingApi.spec.js.map +1 -0
  121. package/dist/tests/unit/contactsApi.spec.d.ts +1 -0
  122. package/dist/tests/unit/contactsApi.spec.js +154 -0
  123. package/dist/tests/unit/contactsApi.spec.js.map +1 -0
  124. package/dist/tests/unit/customFieldApi.spec.d.ts +1 -0
  125. package/dist/tests/unit/customFieldApi.spec.js +140 -0
  126. package/dist/tests/unit/customFieldApi.spec.js.map +1 -0
  127. package/dist/tests/unit/documentApi.spec.d.ts +1 -0
  128. package/dist/tests/unit/documentApi.spec.js +476 -0
  129. package/dist/tests/unit/documentApi.spec.js.map +1 -0
  130. package/dist/tests/unit/planApi.spec.d.ts +1 -0
  131. package/dist/tests/unit/planApi.spec.js +69 -0
  132. package/dist/tests/unit/planApi.spec.js.map +1 -0
  133. package/dist/tests/unit/senderIdentitiesApi.spec.d.ts +1 -0
  134. package/dist/tests/unit/senderIdentitiesApi.spec.js +148 -0
  135. package/dist/tests/unit/senderIdentitiesApi.spec.js.map +1 -0
  136. package/dist/tests/unit/teamApi.spec.d.ts +1 -0
  137. package/dist/tests/unit/teamApi.spec.js +116 -0
  138. package/dist/tests/unit/teamApi.spec.js.map +1 -0
  139. package/dist/tests/unit/templateApi.spec.d.ts +1 -0
  140. package/dist/tests/unit/templateApi.spec.js +285 -0
  141. package/dist/tests/unit/templateApi.spec.js.map +1 -0
  142. package/dist/tests/unit/userApi.spec.d.ts +1 -0
  143. package/dist/tests/unit/userApi.spec.js +163 -0
  144. package/dist/tests/unit/userApi.spec.js.map +1 -0
  145. package/docs/AccessCodeDetail.md +19 -19
  146. package/docs/AccessCodeDetails.md +13 -13
  147. package/docs/Added.md +13 -13
  148. package/docs/Address.md +16 -16
  149. package/docs/AttachmentInfo.md +14 -14
  150. package/docs/AuditTrail.md +21 -21
  151. package/docs/AuthenticationSettings.md +11 -11
  152. package/docs/Base64File.md +12 -12
  153. package/docs/BehalfDocument.md +27 -27
  154. package/docs/BehalfDocumentRecords.md +12 -12
  155. package/docs/BehalfOf.md +12 -12
  156. package/docs/BillingViewModel.md +11 -11
  157. package/docs/BrandCreated.md +11 -11
  158. package/docs/BrandCustomFieldDetails.md +16 -16
  159. package/docs/BrandingApi.md +260 -258
  160. package/docs/BrandingMessage.md +11 -11
  161. package/docs/BrandingRecords.md +11 -11
  162. package/docs/ChangeRecipient.md +18 -18
  163. package/docs/CollaborationSettings.md +14 -0
  164. package/docs/ConditionalRule.md +13 -13
  165. package/docs/ContactCreated.md +12 -12
  166. package/docs/ContactDetails.md +15 -15
  167. package/docs/ContactPageDetails.md +13 -13
  168. package/docs/ContactsApi.md +176 -176
  169. package/docs/ContactsDetails.md +16 -16
  170. package/docs/ContactsList.md +12 -12
  171. package/docs/CreateContactResponse.md +11 -11
  172. package/docs/CreateSenderIdentityRequest.md +16 -16
  173. package/docs/CreateTeamRequest.md +11 -11
  174. package/docs/CreateTemplateRequest.md +35 -35
  175. package/docs/CreateUser.md +14 -14
  176. package/docs/CustomDomainSettings.md +12 -12
  177. package/docs/CustomFieldApi.md +174 -174
  178. package/docs/CustomFieldCollection.md +11 -11
  179. package/docs/CustomFieldMessage.md +12 -12
  180. package/docs/CustomFormField.md +43 -43
  181. package/docs/Date.md +13 -13
  182. package/docs/DeleteCustomFieldReply.md +11 -11
  183. package/docs/Document.md +26 -26
  184. package/docs/DocumentApi.md +756 -756
  185. package/docs/DocumentCC.md +11 -11
  186. package/docs/DocumentCcDetails.md +12 -12
  187. package/docs/DocumentCreated.md +11 -11
  188. package/docs/DocumentExpirySettings.md +16 -16
  189. package/docs/DocumentFiles.md +14 -13
  190. package/docs/DocumentFormFields.md +52 -49
  191. package/docs/DocumentInfo.md +14 -14
  192. package/docs/DocumentProperties.md +50 -50
  193. package/docs/DocumentReassign.md +13 -13
  194. package/docs/DocumentRecords.md +12 -12
  195. package/docs/DocumentSenderDetail.md +14 -14
  196. package/docs/DocumentSigner.md +32 -31
  197. package/docs/DocumentSignerDetails.md +38 -37
  198. package/docs/DocumentTags.md +12 -12
  199. package/docs/DownloadImageRequest.md +16 -16
  200. package/docs/EditSenderIdentityRequest.md +14 -14
  201. package/docs/EditTemplateRequest.md +29 -29
  202. package/docs/EditableDateFieldSettings.md +13 -13
  203. package/docs/EmbeddedCreateTemplateRequest.md +46 -46
  204. package/docs/EmbeddedCustomFieldCreated.md +11 -11
  205. package/docs/EmbeddedDocumentRequest.md +55 -55
  206. package/docs/EmbeddedFileDetails.md +16 -16
  207. package/docs/EmbeddedFileLink.md +11 -11
  208. package/docs/EmbeddedMergeTemplateFormRequest.md +56 -56
  209. package/docs/EmbeddedSendCreated.md +12 -12
  210. package/docs/EmbeddedSendTemplateFormRequest.md +53 -53
  211. package/docs/EmbeddedSigningLink.md +11 -11
  212. package/docs/EmbeddedTemplateCreated.md +12 -12
  213. package/docs/EmbeddedTemplateEditRequest.md +21 -21
  214. package/docs/EmbeddedTemplateEdited.md +11 -11
  215. package/docs/Error.md +12 -12
  216. package/docs/ErrorResult.md +11 -11
  217. package/docs/ExistingFormField.md +15 -15
  218. package/docs/ExtendExpiry.md +14 -14
  219. package/docs/FileInfo.md +14 -14
  220. package/docs/Font.md +18 -18
  221. package/docs/FormField.md +51 -50
  222. package/docs/FormGroup.md +15 -15
  223. package/docs/FormulaFieldSettings.md +12 -12
  224. package/docs/IdDocument.md +21 -21
  225. package/docs/IdReport.md +14 -14
  226. package/docs/IdVerification.md +18 -18
  227. package/docs/IdentityVerificationApi.md +109 -109
  228. package/docs/IdentityVerificationSettings.md +16 -16
  229. package/docs/ImageInfo.md +13 -13
  230. package/docs/MergeAndSendForSignForm.md +46 -46
  231. package/docs/ModificationDetails.md +12 -12
  232. package/docs/NotificationSettings.md +22 -22
  233. package/docs/PageDetails.md +16 -16
  234. package/docs/PhoneNumber.md +12 -12
  235. package/docs/PlanApi.md +38 -38
  236. package/docs/PrefillField.md +12 -12
  237. package/docs/PrefillFieldRequest.md +12 -12
  238. package/docs/ProblemDetails.md +15 -15
  239. package/docs/RecipientChangeLog.md +12 -12
  240. package/docs/RecipientNotificationSettings.md +22 -22
  241. package/docs/Rectangle.md +14 -14
  242. package/docs/ReminderMessage.md +13 -13
  243. package/docs/ReminderSettings.md +13 -13
  244. package/docs/RemoveAuthentication.md +14 -14
  245. package/docs/Removed.md +13 -13
  246. package/docs/RevokeDocument.md +12 -12
  247. package/docs/Role.md +33 -33
  248. package/docs/Roles.md +33 -33
  249. package/docs/SendForSign.md +45 -45
  250. package/docs/SendForSignFromTemplateForm.md +43 -43
  251. package/docs/SenderIdentitiesApi.md +209 -209
  252. package/docs/SenderIdentityCreated.md +11 -11
  253. package/docs/SenderIdentityList.md +12 -12
  254. package/docs/SenderIdentityViewModel.md +19 -19
  255. package/docs/SignerAuthenticationSettings.md +12 -12
  256. package/docs/Size.md +12 -12
  257. package/docs/TeamCreated.md +11 -11
  258. package/docs/TeamDocumentRecords.md +12 -12
  259. package/docs/TeamListResponse.md +12 -12
  260. package/docs/TeamPageDetails.md +12 -12
  261. package/docs/TeamResponse.md +15 -15
  262. package/docs/TeamUpdateRequest.md +12 -12
  263. package/docs/TeamUsers.md +16 -16
  264. package/docs/Teams.md +14 -14
  265. package/docs/TeamsApi.md +141 -141
  266. package/docs/Template.md +29 -29
  267. package/docs/TemplateApi.md +484 -484
  268. package/docs/TemplateCC.md +12 -12
  269. package/docs/TemplateCreated.md +11 -11
  270. package/docs/TemplateFormFields.md +51 -50
  271. package/docs/TemplateProperties.md +37 -37
  272. package/docs/TemplateRecords.md +12 -12
  273. package/docs/TemplateRole.md +28 -28
  274. package/docs/TemplateSenderDetail.md +12 -12
  275. package/docs/TemplateSenderDetails.md +13 -13
  276. package/docs/TemplateSharedTemplateDetail.md +12 -12
  277. package/docs/TemplateSignerDetails.md +27 -27
  278. package/docs/TemplateTag.md +14 -14
  279. package/docs/TextTagDefinition.md +41 -40
  280. package/docs/TextTagOffset.md +12 -12
  281. package/docs/UpdateUser.md +14 -14
  282. package/docs/UpdateUserMetaData.md +12 -12
  283. package/docs/UserApi.md +240 -240
  284. package/docs/UserPageDetails.md +12 -12
  285. package/docs/UserProperties.md +21 -21
  286. package/docs/UserRecords.md +12 -12
  287. package/docs/UsersDetails.md +21 -21
  288. package/docs/Validation.md +13 -13
  289. package/docs/VerificationDataRequest.md +15 -15
  290. package/docs/ViewBrandDetails.md +35 -34
  291. package/docs/ViewCustomFieldDetails.md +17 -17
  292. package/examples/DocumentProperties.ts +14 -14
  293. package/examples/brandCreate.ts +28 -28
  294. package/examples/brandDelete.ts +14 -14
  295. package/examples/brandGet.ts +14 -14
  296. package/examples/brandList.ts +13 -13
  297. package/examples/brandResetDefault.ts +14 -14
  298. package/examples/brandUpdate.ts +20 -20
  299. package/examples/contactCreate.ts +25 -25
  300. package/examples/contactDelete.ts +14 -14
  301. package/examples/contactGet.ts +14 -14
  302. package/examples/contactList.ts +15 -15
  303. package/examples/contactUpdate.ts +25 -25
  304. package/examples/customFieldCreate.ts +27 -27
  305. package/examples/customFieldDelete.ts +14 -14
  306. package/examples/customFieldEdit.ts +29 -29
  307. package/examples/customFieldEmbeddedCreateUrl.ts +18 -18
  308. package/examples/customFieldList.ts +14 -14
  309. package/examples/documentAddAuthentication.ts +19 -19
  310. package/examples/documentAddTags.ts +18 -18
  311. package/examples/documentChangeAccessCode.ts +19 -19
  312. package/examples/documentChangeRecipients.ts +21 -21
  313. package/examples/documentDelete.ts +15 -15
  314. package/examples/documentDeleteTags.ts +18 -18
  315. package/examples/documentDownload.ts +15 -15
  316. package/examples/documentDownloadAttachment.ts +16 -16
  317. package/examples/documentDownloadAuditTrial.ts +15 -15
  318. package/examples/documentEmbeddedRequestLink.ts +48 -48
  319. package/examples/documentEmbeddedSignLink.ts +22 -22
  320. package/examples/documentExtendExpiry.ts +19 -19
  321. package/examples/documentList.ts +18 -18
  322. package/examples/documentListBehalf.ts +14 -14
  323. package/examples/documentListTeam.ts +14 -14
  324. package/examples/documentPrefillFieldCheckBox.ts +22 -22
  325. package/examples/documentPrefillFieldDropDown.ts +22 -22
  326. package/examples/documentPrefillFieldEditableDate.ts +22 -22
  327. package/examples/documentPrefillFieldImage.ts +22 -22
  328. package/examples/documentPrefillFieldRadioButton.ts +22 -22
  329. package/examples/documentPrefillFieldTextBox.ts +22 -22
  330. package/examples/documentRemoveAuthentication.ts +18 -18
  331. package/examples/documentRevoke.ts +18 -18
  332. package/examples/documentSend.ts +46 -46
  333. package/examples/documentSendOnBehalf.ts +52 -52
  334. package/examples/documentSendReminder.ts +19 -19
  335. package/examples/embeddedManualVerification.ts +22 -22
  336. package/examples/identityVerificationImage.ts +23 -23
  337. package/examples/identityVerificationReport.ts +21 -21
  338. package/examples/listTemplate.ts +15 -15
  339. package/examples/plan.ts +13 -13
  340. package/examples/senderIdentityCreate.ts +20 -20
  341. package/examples/senderIdentityDelete.ts +14 -14
  342. package/examples/senderIdentityList.ts +15 -15
  343. package/examples/senderIdentityRerequest.ts +14 -14
  344. package/examples/senderIdentityResendInvitation.ts +14 -14
  345. package/examples/senderIdentityUpdate.ts +19 -19
  346. package/examples/teamCreate.ts +17 -17
  347. package/examples/teamGet.ts +14 -14
  348. package/examples/teamList.ts +15 -15
  349. package/examples/teamUpdate.ts +18 -18
  350. package/examples/templateAddTag.ts +19 -19
  351. package/examples/templateCreate.ts +28 -28
  352. package/examples/templateDelete.ts +14 -14
  353. package/examples/templateDeleteTag.ts +19 -19
  354. package/examples/templateDetails.ts +14 -14
  355. package/examples/templateDownload.ts +14 -14
  356. package/examples/templateEdit.ts +21 -21
  357. package/examples/templateEmbeddedCreate.ts +28 -28
  358. package/examples/templateEmbeddedEdit.ts +23 -23
  359. package/examples/templateEmbeddedRequestLink.ts +33 -33
  360. package/examples/templateMergerEmbeddedRequestUrl.ts +36 -36
  361. package/examples/templateSendDocument.ts +59 -59
  362. package/examples/templateSendDocumentUsingMultipleTemplate.ts +39 -39
  363. package/examples/userCreate.ts +19 -19
  364. package/examples/userGet.ts +14 -14
  365. package/examples/userInvitationCancel.ts +14 -14
  366. package/examples/userList.ts +15 -15
  367. package/examples/userResendInvitation.ts +14 -14
  368. package/examples/userUpdateRole.ts +18 -18
  369. package/git_push.sh +57 -57
  370. package/model/accessCodeDetail.ts +91 -91
  371. package/model/accessCodeDetails.ts +44 -44
  372. package/model/added.ts +43 -43
  373. package/model/address.ts +61 -61
  374. package/model/attachmentInfo.ts +49 -49
  375. package/model/auditTrail.ts +177 -175
  376. package/model/authenticationSettings.ts +40 -40
  377. package/model/base64File.ts +37 -37
  378. package/model/behalfDocument.ts +142 -142
  379. package/model/behalfDocumentRecords.ts +39 -39
  380. package/model/behalfOf.ts +37 -37
  381. package/model/billingViewModel.ts +31 -31
  382. package/model/brandCreated.ts +31 -31
  383. package/model/brandCustomFieldDetails.ts +62 -62
  384. package/model/brandingMessage.ts +31 -31
  385. package/model/brandingRecords.ts +32 -32
  386. package/model/changeRecipient.ts +74 -74
  387. package/model/collaborationSettings.ts +49 -0
  388. package/model/conditionalRule.ts +43 -43
  389. package/model/contactCreated.ts +37 -37
  390. package/model/contactDetails.ts +56 -56
  391. package/model/contactPageDetails.ts +43 -43
  392. package/model/contactsDetails.ts +62 -62
  393. package/model/contactsList.ts +39 -39
  394. package/model/createContactResponse.ts +32 -32
  395. package/model/createSenderIdentityRequest.ts +62 -62
  396. package/model/createTeamRequest.ts +31 -31
  397. package/model/createTemplateRequest.ts +181 -181
  398. package/model/createUser.ts +56 -56
  399. package/model/customDomainSettings.ts +37 -37
  400. package/model/customFieldCollection.ts +32 -32
  401. package/model/customFieldMessage.ts +37 -37
  402. package/model/customFormField.ts +275 -275
  403. package/model/deleteCustomFieldReply.ts +31 -31
  404. package/model/document.ts +135 -135
  405. package/model/documentCC.ts +31 -31
  406. package/model/documentCcDetails.ts +37 -37
  407. package/model/documentCreated.ts +31 -31
  408. package/model/documentExpirySettings.ts +69 -69
  409. package/model/documentFiles.ts +49 -43
  410. package/model/documentFormFields.ts +311 -292
  411. package/model/documentInfo.ts +90 -90
  412. package/model/documentProperties.ts +316 -316
  413. package/model/documentReassign.ts +43 -43
  414. package/model/documentRecords.ts +39 -39
  415. package/model/documentSenderDetail.ts +49 -49
  416. package/model/documentSigner.ts +221 -215
  417. package/model/documentSignerDetails.ts +265 -259
  418. package/model/documentTags.ts +37 -37
  419. package/model/downloadImageRequest.ts +61 -61
  420. package/model/editSenderIdentityRequest.ts +50 -50
  421. package/model/editTemplateRequest.ts +144 -144
  422. package/model/editableDateFieldSettings.ts +43 -43
  423. package/model/embeddedCreateTemplateRequest.ts +271 -271
  424. package/model/embeddedCustomFieldCreated.ts +31 -31
  425. package/model/embeddedDocumentRequest.ts +337 -337
  426. package/model/embeddedFileDetails.ts +61 -61
  427. package/model/embeddedFileLink.ts +31 -31
  428. package/model/embeddedMergeTemplateFormRequest.ts +343 -343
  429. package/model/embeddedSendCreated.ts +37 -37
  430. package/model/embeddedSendTemplateFormRequest.ts +324 -324
  431. package/model/embeddedSigningLink.ts +31 -31
  432. package/model/embeddedTemplateCreated.ts +37 -37
  433. package/model/embeddedTemplateEditRequest.ts +115 -115
  434. package/model/embeddedTemplateEdited.ts +31 -31
  435. package/model/errorResult.ts +31 -31
  436. package/model/existingFormField.ts +55 -55
  437. package/model/extendExpiry.ts +49 -49
  438. package/model/fileInfo.ts +49 -49
  439. package/model/font.ts +89 -89
  440. package/model/formField.ts +327 -320
  441. package/model/formGroup.ts +63 -63
  442. package/model/formulaFieldSettings.ts +37 -37
  443. package/model/idDocument.ts +93 -93
  444. package/model/idReport.ts +50 -50
  445. package/model/idVerification.ts +73 -73
  446. package/model/identityVerificationSettings.ts +75 -75
  447. package/model/imageInfo.ts +43 -43
  448. package/model/index.ts +546 -543
  449. package/model/mergeAndSendForSignForm.ts +261 -261
  450. package/model/modelDate.ts +43 -43
  451. package/model/modelError.ts +37 -37
  452. package/model/models.ts +244 -244
  453. package/model/modificationDetails.ts +37 -37
  454. package/model/notificationSettings.ts +97 -97
  455. package/model/pageDetails.ts +61 -61
  456. package/model/phoneNumber.ts +37 -37
  457. package/model/prefillField.ts +37 -37
  458. package/model/prefillFieldRequest.ts +38 -38
  459. package/model/problemDetails.ts +55 -55
  460. package/model/recipientChangeLog.ts +39 -39
  461. package/model/recipientNotificationSettings.ts +97 -97
  462. package/model/rectangle.ts +49 -49
  463. package/model/reminderMessage.ts +44 -44
  464. package/model/reminderSettings.ts +43 -43
  465. package/model/removeAuthentication.ts +50 -50
  466. package/model/removed.ts +43 -43
  467. package/model/revokeDocument.ts +37 -37
  468. package/model/role.ts +229 -229
  469. package/model/roles.ts +225 -225
  470. package/model/sendForSign.ts +255 -255
  471. package/model/sendForSignFromTemplateForm.ts +242 -242
  472. package/model/senderIdentityCreated.ts +31 -31
  473. package/model/senderIdentityList.ts +39 -39
  474. package/model/senderIdentityViewModel.ts +80 -80
  475. package/model/signerAuthenticationSettings.ts +37 -37
  476. package/model/size.ts +37 -37
  477. package/model/teamCreated.ts +31 -31
  478. package/model/teamDocumentRecords.ts +39 -39
  479. package/model/teamListResponse.ts +39 -39
  480. package/model/teamPageDetails.ts +37 -37
  481. package/model/teamResponse.ts +56 -56
  482. package/model/teamUpdateRequest.ts +37 -37
  483. package/model/teamUsers.ts +73 -73
  484. package/model/teams.ts +49 -49
  485. package/model/template.ts +159 -159
  486. package/model/templateCC.ts +37 -37
  487. package/model/templateCreated.ts +31 -31
  488. package/model/templateFormFields.ts +304 -297
  489. package/model/templateProperties.ts +202 -202
  490. package/model/templateRecords.ts +39 -39
  491. package/model/templateRole.ts +195 -195
  492. package/model/templateSenderDetail.ts +37 -37
  493. package/model/templateSenderDetails.ts +43 -43
  494. package/model/templateSharedTemplateDetail.ts +43 -43
  495. package/model/templateSignerDetails.ts +160 -160
  496. package/model/templateTag.ts +49 -49
  497. package/model/textTagDefinition.ts +255 -248
  498. package/model/textTagOffset.ts +37 -37
  499. package/model/updateUser.ts +60 -60
  500. package/model/updateUserMetaData.ts +37 -37
  501. package/model/userPageDetails.ts +37 -37
  502. package/model/userProperties.ts +91 -91
  503. package/model/userRecords.ts +39 -39
  504. package/model/usersDetails.ts +91 -91
  505. package/model/validation.ts +52 -52
  506. package/model/verificationDataRequest.ts +55 -55
  507. package/model/viewBrandDetails.ts +183 -177
  508. package/model/viewCustomFieldDetails.ts +68 -68
  509. package/package.json +52 -52
  510. package/tests/config.ts +20 -0
  511. package/tests/documents/agreement.pdf +0 -0
  512. package/tests/documents/logo.jpg +0 -0
  513. package/tests/integration/BrandingApiTest.spec.ts +254 -0
  514. package/tests/integration/ContactsApiTest.spec.ts +222 -0
  515. package/tests/integration/CustomFieldApiTest.spec.ts +231 -0
  516. package/tests/integration/DocumentApiTest.spec.ts +1624 -0
  517. package/tests/integration/IdentityVerificationApiTest.spec.ts +114 -0
  518. package/tests/integration/TemplateApiTest.spec.ts +1420 -0
  519. package/tests/integration/planApiTest.spec.ts +26 -0
  520. package/tests/integration/senderIdentity.spec.ts +397 -0
  521. package/tests/integration/teamsApiTest.spec.ts +226 -0
  522. package/tests/integration/usersApiTest.spec.ts +251 -0
  523. package/tests/performance/performanceApiTest.spec.ts +362 -0
  524. package/tests/unit/brandingApi.spec.ts +163 -0
  525. package/tests/unit/contactsApi.spec.ts +143 -0
  526. package/tests/unit/customFieldApi.spec.ts +123 -0
  527. package/tests/unit/documentApi.spec.ts +545 -0
  528. package/tests/unit/planApi.spec.ts +34 -0
  529. package/tests/unit/senderIdentitiesApi.spec.ts +148 -0
  530. package/tests/unit/teamApi.spec.ts +94 -0
  531. package/tests/unit/templateApi.spec.ts +307 -0
  532. package/tests/unit/userApi.spec.ts +162 -0
  533. package/tsconfig.json +24 -24
@@ -0,0 +1,26 @@
1
+ import { PlanApi } from '../../api/planApi';
2
+ import config from '../config';
3
+
4
+ describe('PlanApiTest', () => {
5
+ let planApi:PlanApi;
6
+ beforeAll(() => {
7
+ const apiKey = config.apiKey;
8
+ const baseUrl = config.baseUrl;
9
+ if (!apiKey || !baseUrl) {
10
+ throw new Error("Environment variables 'API_KEY' or 'HOST_URL' are not set.");
11
+ }
12
+ planApi = new PlanApi(baseUrl);
13
+ planApi.setApiKey(apiKey);
14
+ });
15
+ test('should retrieve API credits count with balance greater than or equal to 0', async () => {
16
+ try {
17
+ const response = await planApi.apiCreditsCount();
18
+ console.log("API Credits Count:", response.balanceCredits);
19
+ expect(response).toBeDefined();
20
+ expect(response.balanceCredits).toBeGreaterThanOrEqual(0);
21
+ } catch (error:any) {
22
+ console.log("Error occurred while calling the API:", error.message);
23
+ expect(error.message).toBeUndefined();
24
+ }
25
+ },20000);
26
+ });
@@ -0,0 +1,397 @@
1
+ import { SenderIdentitiesApi } from '../../api/senderIdentitiesApi';
2
+ import { CreateSenderIdentityRequest } from '../../model';
3
+ import * as fs from 'fs';
4
+ import config from '../config';
5
+
6
+
7
+ describe('SenderIdentityTestcase', () => {
8
+ let brandingApi;
9
+ let senderIdentitiesApi:SenderIdentitiesApi;
10
+ let brandId;
11
+ let createdSenderIdentityId:any
12
+ let emailId:any
13
+ const generateRandomEmail = () => {
14
+ const randomNum = Math.floor(1000 + Math.random() * 9000);
15
+ return `sdktesting${randomNum}@syncfusion.com`;
16
+ };
17
+ beforeAll(() => {
18
+ createdSenderIdentityId = null;
19
+ emailId = null;
20
+ brandId = null;
21
+ const apiKey = config.apiKey;
22
+ const baseUrl = config.baseUrl;
23
+ if (!baseUrl || !apiKey) {
24
+ throw new Error("Environment variables 'HOST_URL' or 'API_KEY' are not set.");
25
+ }
26
+ senderIdentitiesApi = new SenderIdentitiesApi(baseUrl);
27
+ senderIdentitiesApi.setApiKey(apiKey);
28
+ emailId = generateRandomEmail();
29
+ console.log(`Generated email: ${emailId}`);
30
+ });
31
+ test('Test1: should create a brand successfully', async () => {
32
+ const brandName = "NodeSDK";
33
+ const brandLogo = fs.createReadStream("tests/documents/logo.jpg");
34
+ try {
35
+ const createBrandApiResponse = await brandingApi.createBrand(brandName, brandLogo);
36
+ brandId = createBrandApiResponse.body.brandId;
37
+ console.log("Brand created successfully:", brandId);
38
+ expect(createBrandApiResponse.body).toBeDefined();
39
+ expect(createBrandApiResponse.response.status).toBe(200);
40
+ expect(createBrandApiResponse.response.statusText).toBe("OK");
41
+ } catch (error) {
42
+ console.log("Error occurred while creating the brand:", error);
43
+ }
44
+ },20000);
45
+ test('Test2: should create sender identity successfully', async () => {
46
+ const createSenderIdentityRequest = new CreateSenderIdentityRequest();
47
+ createSenderIdentityRequest.name = "SenderIdentity API";
48
+ createSenderIdentityRequest.email = emailId;
49
+ createSenderIdentityRequest.redirectUrl = "https://boldsign.com";
50
+ try {
51
+ const response = await senderIdentitiesApi.createSenderIdentities(createSenderIdentityRequest);
52
+ console.log("Sender Identity created successfully:", response);
53
+ createdSenderIdentityId = response;
54
+ console.log("Created Sender Identity ID:", createdSenderIdentityId);
55
+ expect(response).toBeDefined();
56
+ } catch (error:any) {
57
+ console.log("Error occurred while calling the API:", error.message);
58
+ expect(error.message).toBeUndefined();
59
+ }
60
+ },20000);
61
+ test('Test3:should fail when invalid email ID is provided', async () => {
62
+ const createSenderIdentityRequest = new CreateSenderIdentityRequest();
63
+ createSenderIdentityRequest.name = "Luther Cooper";
64
+ createSenderIdentityRequest.email = "INVALID_EMAIL";
65
+ createSenderIdentityRequest.redirectUrl = "https://boldsign.com";
66
+ try {
67
+ const response = await senderIdentitiesApi.createSenderIdentities(createSenderIdentityRequest);
68
+ console.error("Expected error due to invalid email ID, but the response was:", response);
69
+ throw new Error("Test failed, invalid email should not be accepted.");
70
+ } catch (error:any) {
71
+ console.log("Error occurred while calling the API:", error.message);
72
+ expect(error.message).toBeDefined();
73
+ }
74
+ },20000);
75
+ test('Test4: should fail to create sender identity with missing name', async () => {
76
+ const createSenderIdentityRequest = new CreateSenderIdentityRequest();
77
+ createSenderIdentityRequest.name = "";
78
+ createSenderIdentityRequest.email = emailId;
79
+ createSenderIdentityRequest.redirectUrl = "https://boldsign.com";
80
+ try {
81
+ const response = await senderIdentitiesApi.createSenderIdentities(createSenderIdentityRequest);
82
+ console.log("Unexpected success response:", response);
83
+ } catch (error: any) {
84
+ console.log("Expected error occurred:", error);
85
+ expect(error).toBeDefined();
86
+ expect(error.response).toBeDefined();
87
+ expect(error.response.status).toBe(400);
88
+ expect(error.response.statusText).toBe("Bad Request");
89
+ }
90
+ },20000);
91
+ test('Test5: should fail to create sender identity with empty email', async () => {
92
+ const createSenderIdentityRequest = new CreateSenderIdentityRequest();
93
+ createSenderIdentityRequest.name = "Sender Identity API";
94
+ createSenderIdentityRequest.email = "";
95
+ createSenderIdentityRequest.redirectUrl = "https://boldsign.com";
96
+ try {
97
+ const response = await senderIdentitiesApi.createSenderIdentities(createSenderIdentityRequest);
98
+ console.log("Unexpected success response:", response);
99
+ } catch (error: any) {
100
+ console.log("Expected error occurred:", error);
101
+ expect(error.response).toBeDefined();
102
+ expect(error.response.status).toBe(400);
103
+ expect(error.response.statusText).toBe("Bad Request");
104
+ }
105
+ },20000);
106
+ test('Test6:should update sender identity successfully', async () => {
107
+ const updateSenderIdentityRequest = {
108
+ name: "SDKTEST",
109
+ };
110
+ try {
111
+ const response = await senderIdentitiesApi.updateSenderIdentities(emailId, updateSenderIdentityRequest);
112
+ console.log("Sender Identity updated successfully:", response);
113
+ expect(response).toBeDefined();
114
+ } catch (error:any) {
115
+ console.log("Error occurred while calling the API:", error.message);
116
+ expect(error.message).toBeUndefined();
117
+ }
118
+ },20000);
119
+ test('Test7:should fail to update sender identity with invalid email', async () => {
120
+ const updateSenderIdentityRequest = {
121
+ name: "SDKTEST",
122
+ };
123
+ const invalidEmail = "INVALID_EMAIL";
124
+ try {
125
+ const response = await senderIdentitiesApi.updateSenderIdentities(invalidEmail, updateSenderIdentityRequest);
126
+ console.log("Sender Identity updated successfully:", response);
127
+ throw new Error("Expected error but got success.");
128
+ } catch (error:any) {
129
+ console.log("Error occurred while calling the API:", error.message);
130
+ expect(error.message).toBeDefined();
131
+ }
132
+ },20000);
133
+ test('Test8: should fail to update sender identity with empty email', async () => {
134
+ const updateSenderIdentityRequest = {
135
+ name: "SDKTEST",
136
+ };
137
+ const emptyEmail = "";
138
+ try {
139
+ const response = await senderIdentitiesApi.updateSenderIdentities(emptyEmail, updateSenderIdentityRequest);
140
+ console.log("Unexpected success response:", response);
141
+ throw new Error("Expected error but got success.");
142
+ } catch (error: any) {
143
+ console.log("Expected error occurred:", error);
144
+ expect(error).toBeDefined();
145
+ expect(error.response).toBeDefined();
146
+ expect(error.response.status).toBe(400);
147
+ expect(error.response.statusText).toBe("Bad Request");
148
+ }
149
+ },20000);
150
+ test('Test9: should fail to update sender identity with empty name', async () => {
151
+ const updateSenderIdentityRequest = {
152
+ name: "",
153
+ };
154
+ const validEmail = emailId;
155
+ try {
156
+ const response = await senderIdentitiesApi.updateSenderIdentities(validEmail, updateSenderIdentityRequest);
157
+ console.log("Unexpected success response:", response);
158
+ throw new Error("Expected error but got success.");
159
+ } catch (error: any) {
160
+ console.log("Expected error occurred:", error);
161
+ expect(error.response).toBeDefined();
162
+ expect(error.response.status).toBe(400);
163
+ expect(error.response.statusText).toBe("Bad Request");
164
+ }
165
+ },20000);
166
+ test('Test10:should resend invitation sender identity successfully', async () => {
167
+ try {
168
+ const response = await senderIdentitiesApi.resendInvitationSenderIdentities(emailId);
169
+ console.log("Invitation resent successfully:", response);
170
+ expect(response).toBeDefined();
171
+ } catch (error:any) {
172
+ console.log("Error occurred while resending invitation:", error.message);
173
+ expect(error.message).toBeUndefined();
174
+ }
175
+ },20000);
176
+ test('Test11:should fail to resend invitation with invalid email', async () => {
177
+ const invalidEmail = "invalid-email-id";
178
+ try {
179
+ const response = await senderIdentitiesApi.resendInvitationSenderIdentities(invalidEmail);
180
+ console.log("Invitation resent successfully:", response);
181
+ throw new Error("Expected error but got success");
182
+ } catch (error:any) {
183
+ console.log("Error occurred while resending invitation:", error.message);
184
+ expect(error.message).toBeDefined();
185
+ }
186
+ },20000);
187
+ test('Test12:should fail to resend invitation with non existing sender identity email', async () => {
188
+ const invalidEmail = "sdktestinabc@syncfusion.com";
189
+ try {
190
+ const response = await senderIdentitiesApi.resendInvitationSenderIdentities(invalidEmail);
191
+ console.log("Invitation resent successfully:", response);
192
+ throw new Error("Expected error but got success");
193
+ } catch (error:any) {
194
+ console.log("Error occurred while resending invitation:", error);
195
+ expect(error.response).toBeDefined();
196
+ expect(error.response?.status).toBe(400);
197
+ expect(error.response.statusText).toBe("Bad Request");
198
+ }
199
+ },20000);
200
+ test('Test13:should fail to resend invitation with empty email', async () => {
201
+ const invalidEmail = "";
202
+ try {
203
+ const response = await senderIdentitiesApi.resendInvitationSenderIdentities(invalidEmail);
204
+ console.log("Invitation resent successfully:", response);
205
+ throw new Error("Expected error but got success");
206
+ } catch (error:any) {
207
+ console.log("Error occurred while resending invitation:", error);
208
+ expect(error.response).toBeDefined();
209
+ expect(error.response?.status).toBe(400);
210
+ expect(error.response.statusText).toBe("Bad Request");
211
+ }
212
+ },20000);
213
+ test('Test14:should list sender identities successfully', async () => {
214
+ const page = 1;
215
+ const pageSize = 10;
216
+ const search = " ";
217
+ const brandIds = [];
218
+ try {
219
+ const response = await senderIdentitiesApi.listSenderIdentities(page, pageSize, search, brandIds);
220
+ expect(response).toBeDefined();
221
+ } catch (error:any) {
222
+ console.log("Error while listing sender identities:", error.message);
223
+ expect(error.message).toBeUndefined();
224
+ }
225
+ },20000);
226
+ test('Test15:should fail to list sender identities with negative page and page size', async () => {
227
+ const page = -1;
228
+ const pageSize = -10;
229
+ const search = " ";
230
+ const brandIds = [];
231
+ try {
232
+ await senderIdentitiesApi.listSenderIdentities(page, pageSize, search, brandIds);
233
+ throw new Error("Expected error but got success");
234
+ } catch (error:any) {
235
+ console.log("Error while listing sender identities:", error.message);
236
+ expect(error.message).toBeDefined();
237
+ }
238
+ },20000);
239
+ test('Test16:should fail to list sender identities with invalid parameters', async () => {
240
+ const page = 100;
241
+ const pageSize = 10000;
242
+ const search = " ";
243
+ const brandIds = [];
244
+ try {
245
+ await senderIdentitiesApi.listSenderIdentities(page, pageSize, search, brandIds);
246
+ throw new Error("Expected error but got success");
247
+ } catch (error:any) {
248
+ console.log("Error while listing sender identities:", error);
249
+ expect(error.response).toBeDefined();
250
+ expect(error.response?.status).toBe(400);
251
+ expect(error.response.statusText).toBe("Bad Request");
252
+ }
253
+ },20000);
254
+ test('Test17:should fail to process request with invalid email', async () => {
255
+ const invalidEmail = "invalid-email";
256
+ try {
257
+ await senderIdentitiesApi.reRequestSenderIdentities(invalidEmail);
258
+ throw new Error("Expected error but got success");
259
+ } catch (error:any) {
260
+ console.log("Error occurred while re-requesting sender identity:", error.message);
261
+ expect(error.message).toBeDefined();
262
+ }
263
+ },20000);
264
+ test('Test18:should fail to process request with empty email', async () => {
265
+ const emptyEmail = " ";
266
+ try {
267
+ await senderIdentitiesApi.reRequestSenderIdentities(emptyEmail);
268
+ throw new Error("Expected error but got success");
269
+ } catch (error:any) {
270
+ console.log("Error occurred while re-requesting sender identity:", error.message);
271
+ expect(error.message).toBeDefined();
272
+ }
273
+ },20000);
274
+ test('Test19:should fail to process request negative', async () => {
275
+ const emptyEmail = emailId;
276
+ try {
277
+ await senderIdentitiesApi.reRequestSenderIdentities(emptyEmail);
278
+ throw new Error("Expected error but got success");
279
+ } catch (error:any) {
280
+ console.log("Error occurred while re-requesting sender identity:", error);
281
+ expect(error.response).toBeDefined();
282
+ expect(error.response?.status).toBe(400);
283
+ expect(error.response.statusText).toBe("Bad Request");
284
+ }
285
+ },20000);
286
+ test('Test20:should delete sender identity successfully', async function() {
287
+ try {
288
+ const response = await senderIdentitiesApi.deleteSenderIdentities(emailId);
289
+ console.log("Sender identity deleted successfully");
290
+ expect(response).toBeDefined()
291
+ } catch (error:any) {
292
+ console.log("Error occurred while deleting sender identity:", error.message);
293
+ expect(error.message).toBeUndefined();
294
+ }
295
+ },20000);
296
+ test('Test21:should fail to delete sender identity with empty email', async () => {
297
+ const email = "";
298
+ try {
299
+ await senderIdentitiesApi.deleteSenderIdentities(email);
300
+ throw new Error("Expected error but got success");
301
+ } catch (error:any) {
302
+ console.log("Error occurred while deleting sender identity:", error.message);
303
+ expect(error.message).toBeDefined();
304
+ }
305
+ },20000);
306
+ test('Test22:should fail to delete sender identity with invalid email', async () => {
307
+ const email = "invalid-email";
308
+ try {
309
+ await senderIdentitiesApi.deleteSenderIdentities(email);
310
+ throw new Error("Expected error but got success");
311
+ } catch (error:any) {
312
+ console.log("Error occurred while deleting sender identity:", error);
313
+ expect(error.response).toBeDefined();
314
+ expect(error.response?.status).toBe(400);
315
+ expect(error.response.statusText).toBe("Bad Request");
316
+ }
317
+ },20000);
318
+ test('Test23:should fail to delete sender identity with non existing sender identity email', async () => {
319
+ const email = "sdktestinabc@syncfusion.com";
320
+ try {
321
+ await senderIdentitiesApi.deleteSenderIdentities(email);
322
+ throw new Error("Expected error but got success");
323
+ } catch (error:any) {
324
+ console.log("Error occurred while deleting sender identity:", error);
325
+ expect(error.response).toBeDefined();
326
+ expect(error.response?.status).toBe(403);
327
+ expect(error.response.statusText).toBe("Forbidden");
328
+ }
329
+ },20000);
330
+ test('Test24: should create sender identity successfully with existing brand ID', async () => {
331
+ const createSenderIdentityRequest = new CreateSenderIdentityRequest();
332
+ createSenderIdentityRequest.name = "SenderIdentity API";
333
+ createSenderIdentityRequest.email = emailId;
334
+ createSenderIdentityRequest.redirectUrl = "https://boldsign.com";
335
+ createSenderIdentityRequest.brandId = brandId;
336
+ try {
337
+ const response = await senderIdentitiesApi.createSenderIdentities(createSenderIdentityRequest);
338
+ console.log("Sender Identity created successfully:", response);
339
+ createdSenderIdentityId = response.senderIdentityId;
340
+ expect(response).toBeDefined();
341
+ } catch (error) {
342
+ console.log("Error occurred while calling the API:", error);
343
+ expect(error).toBeUndefined();
344
+ }
345
+ }, 20000);
346
+ test('Test25:should delete sender identity successfully', async function() {
347
+ try {
348
+ const response = await senderIdentitiesApi.deleteSenderIdentities(emailId);
349
+ console.log("Sender identity deleted successfully.");
350
+ expect(response).toBeDefined()
351
+ } catch (error) {
352
+ console.log("Error occurred while deleting sender identity:", error);
353
+ expect(error).toBeUndefined();
354
+ }
355
+ },20000);
356
+ test('Test26: should create sender identity successfully with 80-character name', async () => {
357
+ const crypto = require('crypto');
358
+ const generateRandomString = (length) => {
359
+ return crypto.randomBytes(length).toString('hex').slice(0, length);
360
+ };
361
+ const senderIdentityName = generateRandomString(80);
362
+ const createSenderIdentityRequest = new CreateSenderIdentityRequest();
363
+ createSenderIdentityRequest.name = senderIdentityName;
364
+ createSenderIdentityRequest.email = emailId;
365
+ createSenderIdentityRequest.redirectUrl = "https://boldsign.com";
366
+ try {
367
+ const response = await senderIdentitiesApi.createSenderIdentities(createSenderIdentityRequest);
368
+ console.log("Sender Identity created successfully:", response);
369
+ createdSenderIdentityId = response.senderIdentityId;
370
+ console.log("Created Sender Identity ID:", createdSenderIdentityId);
371
+ expect(response).toBeDefined();
372
+ } catch (error) {
373
+ console.error("Error occurred while calling the API:", error);
374
+ expect(error).toBeUndefined();
375
+ }
376
+ }, 20000);
377
+ test('Test27: should fail to create sender identity successfully with 80-character name with duplicate name', async () => {
378
+ const crypto = require('crypto');
379
+ const generateRandomString = (length) => {
380
+ return crypto.randomBytes(length).toString('hex').slice(0, length);
381
+ };
382
+ const senderIdentityName = generateRandomString(80);
383
+ const createSenderIdentityRequest = new CreateSenderIdentityRequest();
384
+ createSenderIdentityRequest.name = senderIdentityName;
385
+ createSenderIdentityRequest.email = emailId;
386
+ createSenderIdentityRequest.redirectUrl = "https://boldsign.com";
387
+ try {
388
+ const response = await senderIdentitiesApi.createSenderIdentities(createSenderIdentityRequest);
389
+ console.log("Sender Identity created successfully:", response);
390
+ } catch (error:any) {
391
+ console.error("Error occurred while calling the API:", error);
392
+ expect(error.response).toBeDefined();
393
+ expect(error.response?.status).toBe(400);
394
+ expect(error.response.statusText).toBe("Bad Request");
395
+ }
396
+ }, 20000);
397
+ });
@@ -0,0 +1,226 @@
1
+ import { TeamsApi } from '../../api/teamsApi';
2
+ import { CreateTeamRequest, TeamListResponse, TeamUpdateRequest } from '../../model';
3
+ import config from '../config';
4
+
5
+ describe('TeamsTestcase', () => {
6
+ let teamsApi:TeamsApi;
7
+ let createdTeamId:any
8
+ let teamName:any
9
+ const randomNumbers = () => {
10
+ const randomNum = Math.floor(100 + Math.random() * 900);
11
+ return String(randomNum);
12
+ };
13
+ beforeAll(() => {
14
+ createdTeamId = null;
15
+ teamName = null;
16
+ const apiKey = config.apiKey;
17
+ const baseUrl = config.baseUrl;
18
+ if (!apiKey || !baseUrl) {
19
+ throw new Error("Environment variables 'API_KEY' or 'HOST_URL' are not set.");
20
+ }
21
+ teamsApi = new TeamsApi(baseUrl);
22
+ teamsApi.setApiKey(apiKey);
23
+ teamName = `sdktestingteam${randomNumbers()}`;
24
+ });
25
+ test('Test1: should create team successfully', async () => {
26
+ const createTeamRequest = new CreateTeamRequest();
27
+ createTeamRequest.teamName = teamName;
28
+ try {
29
+ const createTeamResponse = await teamsApi.createTeam(createTeamRequest);
30
+ console.log('Team created successfully:', createTeamResponse);
31
+ const createdTeam = createTeamResponse?.teamId;
32
+ if (createdTeam && createdTeam) {
33
+ createdTeamId = String(createdTeam);
34
+ console.log('Created Team ID:', createdTeamId);
35
+ } else {
36
+ console.error('Team ID not found in response.');
37
+ throw new Error('Team creation failed.');
38
+ }
39
+ expect(createTeamResponse.teamId).toBeDefined;
40
+ console.log('Created Team ID:', createdTeamId);
41
+ } catch (error:any) {
42
+ console.error('Error occurred while creating team:', error.message);
43
+ expect(error.message).toBeUndefined();
44
+ }
45
+ },20000);
46
+ test('Test2: should return error when team name already exists', async () => {
47
+ const createTeamRequest = new CreateTeamRequest();
48
+ createTeamRequest.teamName = teamName;
49
+ try {
50
+ const response = await teamsApi.createTeam(createTeamRequest);
51
+ console.log('Team created successfully:', response);
52
+ } catch (error: any) {
53
+ console.error('Error occurred while creating team:', error.message);
54
+ expect(error.message).toBeDefined();
55
+ }
56
+ },20000);
57
+ test('Test3: should return error when team name empty', async () => {
58
+ const createTeamRequest = new CreateTeamRequest();
59
+ createTeamRequest.teamName = "";
60
+ try {
61
+ const response = await teamsApi.createTeam(createTeamRequest);
62
+ console.log('Team created successfully:', response);
63
+ } catch (error: any) {
64
+ console.error('Error occurred while creating team:', error);
65
+ expect(error).toBeDefined();
66
+ expect(error.response.status).toBe(400);
67
+ expect(error.response.statusText).toBe('Bad Request');
68
+ }
69
+ },20000);
70
+ test('Test4: should successfully retrieve team list with valid parameters', async () => {
71
+ const page = 1;
72
+ const pageSize = 100;
73
+ try {
74
+ const teamListResponse = await teamsApi.listTeams(page, pageSize);
75
+ expect(teamListResponse.results).toBeDefined;
76
+ const teamsList = teamListResponse?.results;
77
+ if (Array.isArray(teamsList)) {
78
+ for (let team of teamsList) {
79
+ if (team.teamName === teamName) {
80
+ createdTeamId = team.teamId;
81
+ console.log("Created Team ID:", createdTeamId);
82
+ break;
83
+ }
84
+ }
85
+ } else {
86
+ console.error("teamsList is not an array or is null/undefined.");
87
+ throw new Error("teamsList is invalid.");
88
+ }
89
+ expect(createdTeamId !=null);
90
+ } catch (error: any) {
91
+ console.error("Error occurred while retrieving team list:", error.message);
92
+ expect(error.message).toBeUndefined();
93
+ }
94
+ },20000);
95
+ test('Test5:should fail to retrieve team list when invalid parameters are passed', async () => {
96
+ const page = -1;
97
+ const pageSize = -10;
98
+ try {
99
+ const teamListResponse = await teamsApi.listTeams(page, pageSize);
100
+ console.error("Unexpected success response:", teamListResponse);
101
+ throw new Error("Expected error, but API call succeeded");
102
+ }
103
+ catch (error:any)
104
+ {
105
+ console.log("Expected error occurred:", error.message);
106
+ expect(error.message).toBeDefined();
107
+ }
108
+ },20000);
109
+ test('Test6:should fail to retrieve team list when zero value for page and page size', async () => {
110
+ const page = 0;
111
+ const pageSize = 0;
112
+ try {
113
+ const teamListResponse = await teamsApi.listTeams(page, pageSize);
114
+ console.error("Unexpected success response:", teamListResponse);
115
+ throw new Error("Expected error, but API call succeeded");
116
+ }
117
+ catch (error:any)
118
+ {
119
+ console.log("Expected error occurred:", error);
120
+ expect(error).toBeDefined();
121
+ expect(error.response.status).toBe(400);
122
+ expect(error.response.statusText).toBe('Bad Request');
123
+ }
124
+ },20000);
125
+ test('Test7:should throw error for update when already existing team name is provided', async () => {
126
+ const teamUpdateRequest = {
127
+ teamId: createdTeamId,
128
+ teamName: teamName,
129
+ };
130
+ try
131
+ {
132
+ await teamsApi.updateTeam(teamUpdateRequest);
133
+ }
134
+ catch (error:any)
135
+ {
136
+ expect(error).toBeDefined();
137
+ expect(error.response.status).toBe(400);
138
+ expect(error.response.statusText).toBe('Bad Request');
139
+ }
140
+ },20000);
141
+ test('Test8:should return true when valid team update request is passed', async () => {
142
+ const teamUpdateRequest = new TeamUpdateRequest();
143
+ teamUpdateRequest.teamId = createdTeamId;
144
+ teamUpdateRequest.teamName = "Update"+teamName;
145
+ console.log("Teamid before update:", createdTeamId);
146
+ try
147
+ {
148
+ const records = await teamsApi.updateTeam(teamUpdateRequest);
149
+ console.log("Team updated successfully:", records);
150
+ }
151
+ catch (error:any)
152
+ {
153
+ console.error("Error during team update:", error.message);
154
+ expect(error.message).toBeUndefined();
155
+ }
156
+ },20000);
157
+ test('Test9:should throw error for update when invalid team ID is provided', async () => {
158
+ const teamUpdateRequest = {
159
+ teamId: "wrongTeamId",
160
+ teamName: teamName,
161
+ };
162
+ try
163
+ {
164
+ await teamsApi.updateTeam(teamUpdateRequest);
165
+ }
166
+ catch (error:any)
167
+ {
168
+ expect(error.message).toBeDefined();
169
+ }
170
+ },20000);
171
+ test('Test10:should throw error for update when team name is empty', async () => {
172
+ const teamUpdateRequest = {
173
+ teamId: createdTeamId,
174
+ teamName: "",
175
+ };
176
+ try
177
+ {
178
+ await teamsApi.updateTeam(teamUpdateRequest);
179
+ }
180
+ catch (error:any)
181
+ {
182
+ expect(error).toBeDefined();
183
+ expect(error.response.status).toBe(400);
184
+ expect(error.response.statusText).toBe('Bad Request');
185
+ }
186
+ },20000);
187
+ test('Test11:should return true when valid team get request is passed', async () => {
188
+ try
189
+ {
190
+ const records = await teamsApi.getTeam(createdTeamId);
191
+ console.log(records);
192
+ expect(records.teamName != null);
193
+ }
194
+ catch (error:any)
195
+ {
196
+ console.error("Error fetching team:", error.message);
197
+ expect(error.message).toBeUndefined();
198
+ }
199
+ },20000);
200
+ test('Test12:should throw error when invalid team ID is provided', async () => {
201
+ const invalidTeamId = "INVALID_TEAMID";
202
+ try
203
+ {
204
+ await teamsApi.getTeam(invalidTeamId);
205
+ }
206
+ catch (error:any)
207
+ {
208
+ console.log("Expected exception occurred " + error.message);
209
+ expect(error).toBeDefined();
210
+ expect(error.response.status).toBe(400);
211
+ expect(error.response.statusText).toBe('Bad Request');
212
+ }
213
+ },20000);
214
+ test('Test13:should throw error when team ID is empty', async () => {
215
+ const invalidTeamId = "";
216
+ try
217
+ {
218
+ await teamsApi.getTeam(invalidTeamId);
219
+ }
220
+ catch (error:any)
221
+ {
222
+ console.log("Expected exception occurred: " + error.message);
223
+ expect(error.message).toBeDefined();
224
+ }
225
+ },20000);
226
+ });