@verdocs/js-sdk 1.0.8 → 1.0.12

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 (381) hide show
  1. package/.gitignore +4 -0
  2. package/.idea/.gitignore +8 -0
  3. package/.idea/inspectionProfiles/Project_Default.xml +12 -0
  4. package/.idea/js-sdk.iml +11 -0
  5. package/.idea/misc.xml +6 -0
  6. package/.idea/modules.xml +8 -0
  7. package/.idea/vcs.xml +6 -0
  8. package/.prettierrc.js +11 -0
  9. package/LICENSE +21 -0
  10. package/README.md +8 -5
  11. package/__mocks__/axios.ts +3 -0
  12. package/dist/.npmignore +5 -0
  13. package/{Documents → dist/Documents}/Documents.d.ts +9 -0
  14. package/{Documents → dist/Documents}/Documents.js +24 -7
  15. package/{Documents → dist/Documents}/Stars.d.ts +0 -0
  16. package/{Documents → dist/Documents}/Stars.js +2 -2
  17. package/{Documents → dist/Documents}/Templates.d.ts +0 -0
  18. package/{Documents → dist/Documents}/Templates.js +22 -10
  19. package/{Documents → dist/Documents}/Types.d.ts +0 -0
  20. package/{Api → dist/Documents}/Types.js +0 -0
  21. package/{Documents → dist/Documents}/index.d.ts +0 -0
  22. package/{Documents → dist/Documents}/index.js +0 -0
  23. package/dist/HTTP/Transport.d.ts +51 -0
  24. package/dist/HTTP/Transport.js +88 -0
  25. package/{HTTP → dist/HTTP}/Types.d.ts +0 -0
  26. package/{Documents → dist/HTTP}/Types.js +0 -0
  27. package/{HTTP → dist/HTTP}/index.d.ts +0 -0
  28. package/{HTTP → dist/HTTP}/index.js +0 -0
  29. package/{Organizations → dist/Organizations}/ApiKeys.d.ts +0 -0
  30. package/{Organizations → dist/Organizations}/ApiKeys.js +16 -6
  31. package/{Organizations → dist/Organizations}/Groups.d.ts +0 -0
  32. package/{Organizations → dist/Organizations}/Groups.js +22 -8
  33. package/{Organizations → dist/Organizations}/Invitations.d.ts +0 -0
  34. package/dist/Organizations/Invitations.js +36 -0
  35. package/{Organizations → dist/Organizations}/Members.d.ts +0 -0
  36. package/dist/Organizations/Members.js +26 -0
  37. package/{Organizations → dist/Organizations}/Organizations.d.ts +0 -0
  38. package/dist/Organizations/Organizations.js +31 -0
  39. package/{Organizations → dist/Organizations}/Types.d.ts +0 -0
  40. package/{HTTP → dist/Organizations}/Types.js +0 -0
  41. package/{Organizations → dist/Organizations}/Webhooks.d.ts +0 -0
  42. package/dist/Organizations/Webhooks.js +11 -0
  43. package/{Organizations → dist/Organizations}/index.d.ts +0 -0
  44. package/{Organizations → dist/Organizations}/index.js +0 -0
  45. package/dist/README.md +68 -0
  46. package/{Search → dist/Search}/Content.d.ts +0 -0
  47. package/{Search → dist/Search}/Content.js +22 -10
  48. package/{Search → dist/Search}/Types.d.ts +0 -0
  49. package/{Organizations → dist/Search}/Types.js +0 -0
  50. package/{Search → dist/Search}/index.d.ts +0 -0
  51. package/{Search → dist/Search}/index.js +0 -0
  52. package/{Signatures.d.ts → dist/Signatures.d.ts} +0 -0
  53. package/dist/Signatures.js +21 -0
  54. package/{Tags.d.ts → dist/Tags.d.ts} +0 -0
  55. package/dist/Tags.js +16 -0
  56. package/{Templates → dist/Templates}/Documents.d.ts +0 -0
  57. package/{Templates → dist/Templates}/Documents.js +13 -5
  58. package/{Templates → dist/Templates}/Fields.d.ts +0 -0
  59. package/dist/Templates/Fields.js +16 -0
  60. package/{Templates → dist/Templates}/Pages.d.ts +0 -0
  61. package/dist/Templates/Pages.js +21 -0
  62. package/{Templates → dist/Templates}/Reminders.d.ts +0 -0
  63. package/dist/Templates/Reminders.js +21 -0
  64. package/{Templates → dist/Templates}/Roles.d.ts +0 -0
  65. package/dist/Templates/Roles.js +36 -0
  66. package/{Templates → dist/Templates}/Stars.d.ts +0 -0
  67. package/dist/Templates/Stars.js +11 -0
  68. package/{Templates → dist/Templates}/Tags.d.ts +0 -0
  69. package/dist/Templates/Tags.js +16 -0
  70. package/{Templates → dist/Templates}/Templates.d.ts +0 -0
  71. package/{Templates → dist/Templates}/Templates.js +33 -11
  72. package/{Templates → dist/Templates}/Types.d.ts +0 -0
  73. package/{Templates → dist/Templates}/Types.js +0 -0
  74. package/{Templates → dist/Templates}/index.d.ts +0 -0
  75. package/{Templates → dist/Templates}/index.js +0 -0
  76. package/{Users → dist/Users}/Auth.d.ts +6 -6
  77. package/{Users → dist/Users}/Auth.js +27 -13
  78. package/{Users → dist/Users}/Billing.d.ts +0 -0
  79. package/{Users → dist/Users}/Billing.js +0 -0
  80. package/{Api → dist/Users}/Notifications.d.ts +0 -0
  81. package/{Api → dist/Users}/Notifications.js +8 -4
  82. package/{Users → dist/Users}/Profiles.d.ts +0 -0
  83. package/{Users → dist/Users}/Profiles.js +41 -11
  84. package/{Users → dist/Users}/Types.d.ts +13 -0
  85. package/{Search → dist/Users}/Types.js +0 -0
  86. package/{Users → dist/Users}/index.d.ts +0 -0
  87. package/{Users → dist/Users}/index.js +0 -0
  88. package/{Utils → dist/Utils}/DateTime.d.ts +0 -0
  89. package/{Utils → dist/Utils}/DateTime.js +0 -0
  90. package/{Utils → dist/Utils}/index.d.ts +0 -0
  91. package/{Utils → dist/Utils}/index.js +0 -0
  92. package/{Validators.d.ts → dist/Validators.d.ts} +0 -0
  93. package/dist/Validators.js +11 -0
  94. package/{Whitelabel.d.ts → dist/Whitelabel.d.ts} +0 -0
  95. package/dist/Whitelabel.js +11 -0
  96. package/{index.d.ts → dist/index.d.ts} +0 -0
  97. package/{index.js → dist/index.js} +0 -0
  98. package/dist/package.json +64 -0
  99. package/docs/.nojekyll +1 -0
  100. package/docs/README.md +70 -0
  101. package/docs/enums/Templates.Types.SortOptions.md +76 -0
  102. package/docs/enums/Templates.Types.Template.md +153 -0
  103. package/docs/enums/Templates.Types.TemplatePermissions.md +109 -0
  104. package/docs/enums/Templates.Types.TemplateSenderTypes.md +65 -0
  105. package/docs/interfaces/Documents.Documents-1.IActivityEntry.md +120 -0
  106. package/docs/interfaces/Documents.Documents-1.IDocument.md +175 -0
  107. package/docs/interfaces/Documents.Documents-1.IDocumentSearchOptions.md +98 -0
  108. package/docs/interfaces/Documents.Documents-1.IDocumentsSearchResult.md +43 -0
  109. package/docs/interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.md +131 -0
  110. package/docs/interfaces/Documents.Documents-1.IDocumentsSummary.md +67 -0
  111. package/docs/interfaces/Documents.Documents-1.IHistory.md +76 -0
  112. package/docs/interfaces/Documents.Documents-1.IRecipient.md +208 -0
  113. package/docs/interfaces/Documents.Types.ITemplateSummaryEntry.md +186 -0
  114. package/docs/interfaces/Documents.Types.ITemplatesSummary.md +43 -0
  115. package/docs/interfaces/Organizations.Types.IApiKey.md +60 -0
  116. package/docs/interfaces/Organizations.Types.IApiKeyWithSecret.md +87 -0
  117. package/docs/interfaces/Organizations.Types.ICreateApiKeyRequest.md +32 -0
  118. package/docs/interfaces/Organizations.Types.IGroup.md +101 -0
  119. package/docs/interfaces/Organizations.Types.IGroupDetail.md +129 -0
  120. package/docs/interfaces/Organizations.Types.IOrganization.md +128 -0
  121. package/docs/interfaces/Organizations.Types.IUpdateApiKeyRequest.md +32 -0
  122. package/docs/interfaces/Signatures.ISignature.md +65 -0
  123. package/docs/interfaces/Tags.ITags.md +43 -0
  124. package/docs/interfaces/Templates.Types.IDocument.md +109 -0
  125. package/docs/interfaces/Templates.Types.IField.md +109 -0
  126. package/docs/interfaces/Templates.Types.IPage.md +87 -0
  127. package/docs/interfaces/Templates.Types.IReminder.md +109 -0
  128. package/docs/interfaces/Templates.Types.IRole.md +120 -0
  129. package/docs/interfaces/Templates.Types.ISetting.md +98 -0
  130. package/docs/interfaces/Templates.Types.IStar.md +32 -0
  131. package/docs/interfaces/Templates.Types.ITag.md +32 -0
  132. package/docs/interfaces/Templates.Types.ITemplate.md +219 -0
  133. package/docs/interfaces/Templates.Types.ITemplateSearchParams.md +197 -0
  134. package/docs/interfaces/Templates.Types.ITemplateSummaryEntry.md +186 -0
  135. package/docs/interfaces/Templates.Types.ITemplatesSearchResult.md +43 -0
  136. package/docs/interfaces/Templates.Types.ITemplatesSummary.md +43 -0
  137. package/docs/interfaces/Templates.Types.ITimePeriod.md +32 -0
  138. package/docs/interfaces/Users.Types.IActiveSession.md +131 -0
  139. package/docs/interfaces/Users.Types.IAuthenticateAppRequest.md +32 -0
  140. package/docs/interfaces/Users.Types.IAuthenticateResponse.md +43 -0
  141. package/docs/interfaces/Users.Types.IAuthenticateUserRequest.md +32 -0
  142. package/docs/interfaces/Users.Types.ICreateProfileRequest.md +54 -0
  143. package/docs/interfaces/Users.Types.IPermission.md +36 -0
  144. package/docs/interfaces/Users.Types.IProfile.md +173 -0
  145. package/docs/interfaces/Users.Types.IRole.md +36 -0
  146. package/docs/interfaces/Users.Types.ISwitchProfileResponse.md +54 -0
  147. package/docs/interfaces/Users.Types.IUpdateProfileRequest.md +43 -0
  148. package/docs/interfaces/Users.Types.TokenValidationRequest.md +21 -0
  149. package/docs/interfaces/Users.Types.TokenValidationResponse.md +36 -0
  150. package/docs/interfaces/Users.Types.UpdateEmailRequest.md +21 -0
  151. package/docs/interfaces/Users.Types.UpdateEmailResponse.md +21 -0
  152. package/docs/interfaces/Users.Types.UpdatePasswordRequest.md +43 -0
  153. package/docs/interfaces/Users.Types.UpdatePasswordResponse.md +34 -0
  154. package/docs/interfaces/Validators.IValidator.md +32 -0
  155. package/docs/modules/Documents.Documents-1.md +137 -0
  156. package/docs/modules/Documents.Stars.md +31 -0
  157. package/docs/modules/Documents.Templates.md +61 -0
  158. package/docs/modules/Documents.Types.md +12 -0
  159. package/docs/modules/Documents.md +12 -0
  160. package/docs/modules/HTTP.Transport.md +150 -0
  161. package/docs/modules/HTTP.Types.md +21 -0
  162. package/docs/modules/HTTP.md +10 -0
  163. package/docs/modules/Organizations.ApiKeys.md +169 -0
  164. package/docs/modules/Organizations.Groups.md +190 -0
  165. package/docs/modules/Organizations.Invitations.md +166 -0
  166. package/docs/modules/Organizations.Members.md +121 -0
  167. package/docs/modules/Organizations.Organizations-1.md +119 -0
  168. package/docs/modules/Organizations.Types.md +17 -0
  169. package/docs/modules/Organizations.Webhooks.md +53 -0
  170. package/docs/modules/Organizations.md +20 -0
  171. package/docs/modules/Signatures.md +90 -0
  172. package/docs/modules/Tags.md +75 -0
  173. package/docs/modules/Templates.Documents.md +129 -0
  174. package/docs/modules/Templates.Fields.md +77 -0
  175. package/docs/modules/Templates.Pages.md +98 -0
  176. package/docs/modules/Templates.Reminders.md +98 -0
  177. package/docs/modules/Templates.Roles.md +163 -0
  178. package/docs/modules/Templates.Stars.md +52 -0
  179. package/docs/modules/Templates.Tags.md +75 -0
  180. package/docs/modules/Templates.Templates-1.md +139 -0
  181. package/docs/modules/Templates.Types.md +31 -0
  182. package/docs/modules/Templates.md +17 -0
  183. package/docs/modules/Users.Auth.md +196 -0
  184. package/docs/modules/Users.Billing.md +5 -0
  185. package/docs/modules/Users.Notifications.md +25 -0
  186. package/docs/modules/Users.Profiles.md +286 -0
  187. package/docs/modules/Users.Types.md +62 -0
  188. package/docs/modules/Users.md +13 -0
  189. package/docs/modules/Utils.DateTime.md +31 -0
  190. package/docs/modules/Utils.md +9 -0
  191. package/docs/modules/Validators.md +48 -0
  192. package/docs/modules/Whitelabel.md +38 -0
  193. package/docs/modules.md +27 -0
  194. package/docs-html/.nojekyll +1 -0
  195. package/docs-html/assets/highlight.css +85 -0
  196. package/docs-html/assets/icons.css +1043 -0
  197. package/docs-html/assets/icons.png +0 -0
  198. package/docs-html/assets/icons@2x.png +0 -0
  199. package/docs-html/assets/main.js +52 -0
  200. package/docs-html/assets/search.js +1 -0
  201. package/docs-html/assets/style.css +1384 -0
  202. package/docs-html/assets/widgets.png +0 -0
  203. package/docs-html/assets/widgets@2x.png +0 -0
  204. package/docs-html/enums/Templates.Types.SortOptions.html +1 -0
  205. package/docs-html/enums/Templates.Types.Template.html +1 -0
  206. package/docs-html/enums/Templates.Types.TemplatePermissions.html +1 -0
  207. package/docs-html/enums/Templates.Types.TemplateSenderTypes.html +1 -0
  208. package/docs-html/index.html +64 -0
  209. package/docs-html/interfaces/Documents.Documents-1.IActivityEntry.html +1 -0
  210. package/docs-html/interfaces/Documents.Documents-1.IDocument.html +1 -0
  211. package/docs-html/interfaces/Documents.Documents-1.IDocumentSearchOptions.html +1 -0
  212. package/docs-html/interfaces/Documents.Documents-1.IDocumentsSearchResult.html +1 -0
  213. package/docs-html/interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.html +1 -0
  214. package/docs-html/interfaces/Documents.Documents-1.IDocumentsSummary.html +1 -0
  215. package/docs-html/interfaces/Documents.Documents-1.IHistory.html +1 -0
  216. package/docs-html/interfaces/Documents.Documents-1.IRecipient.html +1 -0
  217. package/docs-html/interfaces/Documents.Types.ITemplateSummaryEntry.html +1 -0
  218. package/docs-html/interfaces/Documents.Types.ITemplatesSummary.html +1 -0
  219. package/docs-html/interfaces/Organizations.Types.IApiKey.html +1 -0
  220. package/docs-html/interfaces/Organizations.Types.IApiKeyWithSecret.html +1 -0
  221. package/docs-html/interfaces/Organizations.Types.ICreateApiKeyRequest.html +1 -0
  222. package/docs-html/interfaces/Organizations.Types.IGroup.html +9 -0
  223. package/docs-html/interfaces/Organizations.Types.IGroupDetail.html +9 -0
  224. package/docs-html/interfaces/Organizations.Types.IOrganization.html +9 -0
  225. package/docs-html/interfaces/Organizations.Types.IUpdateApiKeyRequest.html +1 -0
  226. package/docs-html/interfaces/Signatures.ISignature.html +1 -0
  227. package/docs-html/interfaces/Tags.ITags.html +1 -0
  228. package/docs-html/interfaces/Templates.Types.IDocument.html +1 -0
  229. package/docs-html/interfaces/Templates.Types.IField.html +1 -0
  230. package/docs-html/interfaces/Templates.Types.IPage.html +1 -0
  231. package/docs-html/interfaces/Templates.Types.IReminder.html +1 -0
  232. package/docs-html/interfaces/Templates.Types.IRole.html +1 -0
  233. package/docs-html/interfaces/Templates.Types.ISetting.html +1 -0
  234. package/docs-html/interfaces/Templates.Types.IStar.html +1 -0
  235. package/docs-html/interfaces/Templates.Types.ITag.html +1 -0
  236. package/docs-html/interfaces/Templates.Types.ITemplate.html +1 -0
  237. package/docs-html/interfaces/Templates.Types.ITemplateSearchParams.html +1 -0
  238. package/docs-html/interfaces/Templates.Types.ITemplateSummaryEntry.html +1 -0
  239. package/docs-html/interfaces/Templates.Types.ITemplatesSearchResult.html +1 -0
  240. package/docs-html/interfaces/Templates.Types.ITemplatesSummary.html +1 -0
  241. package/docs-html/interfaces/Templates.Types.ITimePeriod.html +1 -0
  242. package/docs-html/interfaces/Users.Types.IActiveSession.html +1 -0
  243. package/docs-html/interfaces/Users.Types.IAuthenticateAppRequest.html +1 -0
  244. package/docs-html/interfaces/Users.Types.IAuthenticateResponse.html +1 -0
  245. package/docs-html/interfaces/Users.Types.IAuthenticateUserRequest.html +1 -0
  246. package/docs-html/interfaces/Users.Types.ICreateProfileRequest.html +1 -0
  247. package/docs-html/interfaces/Users.Types.IPermission.html +5 -0
  248. package/docs-html/interfaces/Users.Types.IProfile.html +21 -0
  249. package/docs-html/interfaces/Users.Types.IRole.html +5 -0
  250. package/docs-html/interfaces/Users.Types.ISwitchProfileResponse.html +1 -0
  251. package/docs-html/interfaces/Users.Types.IUpdateProfileRequest.html +1 -0
  252. package/docs-html/interfaces/Users.Types.TokenValidationRequest.html +1 -0
  253. package/docs-html/interfaces/Users.Types.TokenValidationResponse.html +5 -0
  254. package/docs-html/interfaces/Users.Types.UpdateEmailRequest.html +1 -0
  255. package/docs-html/interfaces/Users.Types.UpdateEmailResponse.html +1 -0
  256. package/docs-html/interfaces/Users.Types.UpdatePasswordRequest.html +1 -0
  257. package/docs-html/interfaces/Users.Types.UpdatePasswordResponse.html +3 -0
  258. package/docs-html/interfaces/Validators.IValidator.html +1 -0
  259. package/docs-html/modules/Documents.Documents-1.html +9 -0
  260. package/docs-html/modules/Documents.Stars.html +1 -0
  261. package/docs-html/modules/Documents.Templates.html +1 -0
  262. package/docs-html/modules/Documents.Types.html +1 -0
  263. package/docs-html/modules/Documents.html +1 -0
  264. package/docs-html/modules/HTTP.Transport.html +22 -0
  265. package/docs-html/modules/HTTP.Types.html +1 -0
  266. package/docs-html/modules/HTTP.html +1 -0
  267. package/docs-html/modules/Organizations.ApiKeys.html +29 -0
  268. package/docs-html/modules/Organizations.Groups.html +15 -0
  269. package/docs-html/modules/Organizations.Invitations.html +1 -0
  270. package/docs-html/modules/Organizations.Members.html +1 -0
  271. package/docs-html/modules/Organizations.Organizations-1.html +1 -0
  272. package/docs-html/modules/Organizations.Types.html +1 -0
  273. package/docs-html/modules/Organizations.Webhooks.html +1 -0
  274. package/docs-html/modules/Organizations.html +6 -0
  275. package/docs-html/modules/Signatures.html +1 -0
  276. package/docs-html/modules/Tags.html +1 -0
  277. package/docs-html/modules/Templates.Documents.html +17 -0
  278. package/docs-html/modules/Templates.Fields.html +1 -0
  279. package/docs-html/modules/Templates.Pages.html +1 -0
  280. package/docs-html/modules/Templates.Reminders.html +1 -0
  281. package/docs-html/modules/Templates.Roles.html +1 -0
  282. package/docs-html/modules/Templates.Stars.html +1 -0
  283. package/docs-html/modules/Templates.Tags.html +1 -0
  284. package/docs-html/modules/Templates.Templates-1.html +5 -0
  285. package/docs-html/modules/Templates.Types.html +1 -0
  286. package/docs-html/modules/Templates.html +1 -0
  287. package/docs-html/modules/Users.Auth.html +31 -0
  288. package/docs-html/modules/Users.Billing.html +1 -0
  289. package/docs-html/modules/Users.Notifications.html +1 -0
  290. package/docs-html/modules/Users.Profiles.html +44 -0
  291. package/docs-html/modules/Users.Types.html +1 -0
  292. package/docs-html/modules/Users.html +1 -0
  293. package/docs-html/modules/Utils.DateTime.html +1 -0
  294. package/docs-html/modules/Utils.html +1 -0
  295. package/docs-html/modules/Validators.html +1 -0
  296. package/docs-html/modules/Whitelabel.html +1 -0
  297. package/docs-html/modules.html +11 -0
  298. package/jestconfig.json +11 -0
  299. package/package-lock.json +3421 -0
  300. package/package.json +6 -3
  301. package/src/Documents/Documents.ts +166 -0
  302. package/src/Documents/Stars.ts +5 -0
  303. package/src/Documents/Templates.ts +17 -0
  304. package/src/Documents/Types.ts +24 -0
  305. package/src/Documents/index.ts +4 -0
  306. package/src/HTTP/Transport.ts +95 -0
  307. package/src/HTTP/Types.ts +1 -0
  308. package/src/HTTP/index.ts +2 -0
  309. package/src/Organizations/ApiKeys.ts +85 -0
  310. package/src/Organizations/Groups.ts +65 -0
  311. package/src/Organizations/Invitations.ts +36 -0
  312. package/src/Organizations/Members.ts +26 -0
  313. package/src/Organizations/Organizations.ts +32 -0
  314. package/src/Organizations/Types.ts +63 -0
  315. package/src/Organizations/Webhooks.ts +11 -0
  316. package/src/Organizations/index.ts +16 -0
  317. package/src/Search/Content.ts +45 -0
  318. package/src/Search/Types.ts +83 -0
  319. package/src/Search/index.ts +2 -0
  320. package/src/Signatures.ts +29 -0
  321. package/src/Tags.ts +22 -0
  322. package/src/Templates/Documents.ts +58 -0
  323. package/src/Templates/Fields.ts +17 -0
  324. package/src/Templates/Pages.ts +22 -0
  325. package/src/Templates/Reminders.ts +22 -0
  326. package/src/Templates/Roles.ts +37 -0
  327. package/src/Templates/Stars.ts +12 -0
  328. package/src/Templates/Tags.ts +17 -0
  329. package/src/Templates/Templates.ts +42 -0
  330. package/src/Templates/Types.ts +201 -0
  331. package/src/Templates/index.ts +9 -0
  332. package/src/Users/Auth.ts +114 -0
  333. package/src/Users/Billing.ts +3 -0
  334. package/src/Users/Notifications.ts +6 -0
  335. package/src/Users/Profiles.ts +153 -0
  336. package/src/Users/Types.ts +156 -0
  337. package/src/Users/index.ts +5 -0
  338. package/src/Utils/DateTime.ts +43 -0
  339. package/src/Utils/index.ts +1 -0
  340. package/src/Validators.ts +16 -0
  341. package/src/Whitelabel.ts +11 -0
  342. package/src/__tests__/Organizations/Apikeys.spec.ts +84 -0
  343. package/src/__tests__/Users/Auth.spec.ts +89 -0
  344. package/src/__tests__/Users/Profiles.spec.ts +162 -0
  345. package/src/index.ts +23 -0
  346. package/tsconfig.json +20 -0
  347. package/tslint.json +3 -0
  348. package/Api/Auth.d.ts +0 -71
  349. package/Api/Auth.js +0 -24
  350. package/Api/Documents.d.ts +0 -124
  351. package/Api/Documents.js +0 -47
  352. package/Api/Endpoint.d.ts +0 -2
  353. package/Api/Endpoint.js +0 -9
  354. package/Api/Templates.d.ts +0 -33
  355. package/Api/Templates.js +0 -55
  356. package/Api/Types.d.ts +0 -182
  357. package/Api/index.d.ts +0 -2
  358. package/Api/index.js +0 -2
  359. package/AuthManager.d.ts +0 -14
  360. package/AuthManager.js +0 -53
  361. package/HTTP/Endpoint.d.ts +0 -4
  362. package/HTTP/Endpoint.js +0 -12
  363. package/HTTP/Transport.d.ts +0 -3
  364. package/HTTP/Transport.js +0 -12
  365. package/Organizations/Invitations.js +0 -22
  366. package/Organizations/Members.js +0 -16
  367. package/Organizations/Organizations.js +0 -13
  368. package/Organizations/Webhooks.js +0 -7
  369. package/Signatures.js +0 -7
  370. package/Tags.js +0 -4
  371. package/Templates/Fields.js +0 -10
  372. package/Templates/Pages.js +0 -13
  373. package/Templates/Reminders.js +0 -13
  374. package/Templates/Roles.js +0 -22
  375. package/Templates/Stars.js +0 -7
  376. package/Templates/Tags.js +0 -10
  377. package/Users/Notifications.d.ts +0 -1
  378. package/Users/Notifications.js +0 -40
  379. package/Users/Types.js +0 -1
  380. package/Validators.js +0 -5
  381. package/Whitelabel.js +0 -3
package/docs-html/modules/Users.Profiles.html ADDED
@@ -0,0 +1,44 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Profiles | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Users.html">Users</a></li><li><a href="Users.Profiles.html">Profiles</a></li></ul><h1>Namespace Profiles</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#createProfile" class="tsd-kind-icon">create<wbr/>Profile</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#deleteProfile" class="tsd-kind-icon">delete<wbr/>Profile</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getPermissions" class="tsd-kind-icon">get<wbr/>Permissions</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getProfile" class="tsd-kind-icon">get<wbr/>Profile</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getProfileGroups" class="tsd-kind-icon">get<wbr/>Profile<wbr/>Groups</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getProfilePermissions" class="tsd-kind-icon">get<wbr/>Profile<wbr/>Permissions</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getProfiles" class="tsd-kind-icon">get<wbr/>Profiles</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getRoles" class="tsd-kind-icon">get<wbr/>Roles</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#switchProfile" class="tsd-kind-icon">switch<wbr/>Profile</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#updateProfile" class="tsd-kind-icon">update<wbr/>Profile</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="createProfile" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Profile</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Profile<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Users.Types.ICreateProfileRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ICreateProfileRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">IProfile</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L63">Users/Profiles.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Create a profile. If the caller does not have a &quot;current&quot; profile set, the new profile will be made current.</p>
3
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">newProfile</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">createProfile</span><span class="hl-1">({ </span><span class="hl-0">first_name:</span><span class="hl-1"> </span><span class="hl-3">&#39;FIRST&#39;</span><span class="hl-1">, </span><span class="hl-0">last_name:</span><span class="hl-1"> </span><span class="hl-3">&#39;LAST&#39;</span><span class="hl-1">, </span><span class="hl-0">email:</span><span class="hl-1"> </span><span class="hl-3">&#39;EMAIL&#39;</span><span class="hl-1"> });</span>
4
+ </code></pre>
5
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../interfaces/Users.Types.ICreateProfileRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ICreateProfileRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">IProfile</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deleteProfile" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Profile</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Profile<span class="tsd-signature-symbol">(</span>profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L150">Users/Profiles.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>Delete a profile. If the requested profile is the caller&#39;s curent profile, the next available profile will be selected.</p>
7
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">deleteProfile</span><span class="hl-1">(</span><span class="hl-3">&#39;PROFILEID&#39;</span><span class="hl-1">);</span>
8
+ </code></pre>
9
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getPermissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Permissions</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Permissions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">IPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L49">Users/Profiles.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>Get a list of system roles.</p>
11
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">permissions</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">getPermissions</span><span class="hl-1">();</span>
12
+ </code></pre>
13
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">IPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getProfile" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Profile</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Profile<span class="tsd-signature-symbol">(</span>profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">IProfile</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L78">Users/Profiles.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>Get a profile. The caller must have admin access to the given profile.
15
+ TODO: Add a &quot;public&quot; profile endpoint for public pages</p>
16
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">profile</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">getProfile</span><span class="hl-1">(</span><span class="hl-3">&#39;PROFILEID&#39;</span><span class="hl-1">);</span>
17
+ </code></pre>
18
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">IProfile</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getProfileGroups" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Profile<wbr/>Groups</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Profile<wbr/>Groups<span class="tsd-signature-symbol">(</span>profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Organizations.Types.IGroup.html" class="tsd-signature-type" data-tsd-kind="Interface">IGroup</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L106">Users/Profiles.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>Get a profile&#39;s groups.</p>
20
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">groups</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">getProfileGroups</span><span class="hl-1">(</span><span class="hl-3">&#39;PROFILEID&#39;</span><span class="hl-1">);</span>
21
+ </code></pre>
22
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Organizations.Types.IGroup.html" class="tsd-signature-type" data-tsd-kind="Interface">IGroup</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getProfilePermissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Profile<wbr/>Permissions</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Profile<wbr/>Permissions<span class="tsd-signature-symbol">(</span>profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">IPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L92">Users/Profiles.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
23
+ <p>Get a profile&#39;s permissions. The caller must have admin access to the given profile.</p>
24
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">permissions</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">getProfilePermissions</span><span class="hl-1">(</span><span class="hl-3">&#39;PROFILEID&#39;</span><span class="hl-1">);</span>
25
+ </code></pre>
26
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IPermission.html" class="tsd-signature-type" data-tsd-kind="Interface">IPermission</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getProfiles" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Profiles</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Profiles<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">IProfile</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L21">Users/Profiles.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
27
+ <p>Get the user&#39;s available profiles. The current profile will be marked with <code>current: true</code>.</p>
28
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">profiles</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">getProfiles</span><span class="hl-1">()</span>
29
+ </code></pre>
30
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">IProfile</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getRoles" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Roles</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Roles<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L35">Users/Profiles.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
31
+ <p>Get a list of system roles.</p>
32
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">roles</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">getRoles</span><span class="hl-1">();</span>
33
+ </code></pre>
34
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="switchProfile" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> switch<wbr/>Profile</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">switch<wbr/>Profile<span class="tsd-signature-symbol">(</span>profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.ISwitchProfileResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ISwitchProfileResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L121">Users/Profiles.ts:121</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
35
+ <p>Switch the caller&#39;s &quot;current&quot; profile. The current profile is used for permissions checking and profile_id field settings
36
+ for most operations in Verdocs. It is important to select the appropropriate profile before calling other API functions.</p>
37
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">newProfile</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">switchProfile</span><span class="hl-1">(</span><span class="hl-3">&#39;PROFILEID&#39;</span><span class="hl-1">);</span>
38
+ </code></pre>
39
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.ISwitchProfileResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ISwitchProfileResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="updateProfile" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> update<wbr/>Profile</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">update<wbr/>Profile<span class="tsd-signature-symbol">(</span>profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Users.Types.IUpdateProfileRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">IUpdateProfileRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">IProfile</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L136">Users/Profiles.ts:136</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
40
+ <p>Update a profile. For future expansion, the profile ID to update is required, but currently this must also be the
41
+ &quot;current&quot; profile for the caller.</p>
42
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Profiles</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@verdocs/js-sdk/Users&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">newProfile</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Profiles</span><span class="hl-1">.</span><span class="hl-6">updateProfile</span><span class="hl-1">(</span><span class="hl-3">&#39;PROFILEID&#39;</span><span class="hl-1">);</span>
43
+ </code></pre>
44
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li><li><h5>params: <a href="../interfaces/Users.Types.IUpdateProfileRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">IUpdateProfileRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">IProfile</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class="current tsd-kind-namespace"><a href="Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Notifications.html">Notifications</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Profiles.html">Profiles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Types.html">Types</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#createProfile" class="tsd-kind-icon">create<wbr/>Profile</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#deleteProfile" class="tsd-kind-icon">delete<wbr/>Profile</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getPermissions" class="tsd-kind-icon">get<wbr/>Permissions</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getProfile" class="tsd-kind-icon">get<wbr/>Profile</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getProfileGroups" class="tsd-kind-icon">get<wbr/>Profile<wbr/>Groups</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getProfilePermissions" class="tsd-kind-icon">get<wbr/>Profile<wbr/>Permissions</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getProfiles" class="tsd-kind-icon">get<wbr/>Profiles</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#getRoles" class="tsd-kind-icon">get<wbr/>Roles</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#switchProfile" class="tsd-kind-icon">switch<wbr/>Profile</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Profiles.html#updateProfile" class="tsd-kind-icon">update<wbr/>Profile</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs-html/modules/Users.Types.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Types | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Users.html">Users</a></li><li><a href="Users.Types.html">Types</a></li></ul><h1>Namespace Types</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IActiveSession.html" class="tsd-kind-icon">IActive<wbr/>Session</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IAuthenticateAppRequest.html" class="tsd-kind-icon">IAuthenticate<wbr/>App<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IAuthenticateResponse.html" class="tsd-kind-icon">IAuthenticate<wbr/>Response</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IAuthenticateUserRequest.html" class="tsd-kind-icon">IAuthenticate<wbr/>User<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.ICreateProfileRequest.html" class="tsd-kind-icon">ICreate<wbr/>Profile<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IPermission.html" class="tsd-kind-icon">IPermission</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IProfile.html" class="tsd-kind-icon">IProfile</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IRole.html" class="tsd-kind-icon">IRole</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.ISwitchProfileResponse.html" class="tsd-kind-icon">ISwitch<wbr/>Profile<wbr/>Response</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IUpdateProfileRequest.html" class="tsd-kind-icon">IUpdate<wbr/>Profile<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.TokenValidationRequest.html" class="tsd-kind-icon">Token<wbr/>Validation<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.TokenValidationResponse.html" class="tsd-kind-icon">Token<wbr/>Validation<wbr/>Response</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.UpdateEmailRequest.html" class="tsd-kind-icon">Update<wbr/>Email<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.UpdateEmailResponse.html" class="tsd-kind-icon">Update<wbr/>Email<wbr/>Response</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.UpdatePasswordRequest.html" class="tsd-kind-icon">Update<wbr/>Password<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.UpdatePasswordResponse.html" class="tsd-kind-icon">Update<wbr/>Password<wbr/>Response</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Users.Types.html#TPermission" class="tsd-kind-icon">TPermission</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Users.Types.html#TPlan" class="tsd-kind-icon">TPlan</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Users.Types.html#TRole" class="tsd-kind-icon">TRole</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="TPermission" class="tsd-anchor"></a><h3>TPermission</h3><div class="tsd-signature tsd-kind-icon">TPermission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;org:view&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;member:view&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;org:update&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;member:add&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;member:remove&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;admin:add&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;admin:remove&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;org:delete&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;org:transfer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;owner:add&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;owner:remove&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;template:creator:create:personal&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;template:creator:visibility&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;template:creator:create:org&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;template:member:read&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;template:member:write&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;template:member:visibility&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;template:creator:delete&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;template:member:delete&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;template:creator:create:public&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;rform:access&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;rcommon:access&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;org:list&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;org:create&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L4">Users/Types.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="TPlan" class="tsd-anchor"></a><h3>TPlan</h3><div class="tsd-signature tsd-kind-icon">TPlan<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;env:essential&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;org:standard&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L30">Users/Types.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="TRole" class="tsd-anchor"></a><h3>TRole</h3><div class="tsd-signature tsd-kind-icon">TRole<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;owner&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;basic_user&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;member&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L32">Users/Types.ts:32</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class="current tsd-kind-namespace"><a href="Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Profiles.html">Profiles</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Types.html">Types</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IActiveSession.html" class="tsd-kind-icon">IActive<wbr/>Session</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IAuthenticateAppRequest.html" class="tsd-kind-icon">IAuthenticate<wbr/>App<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IAuthenticateResponse.html" class="tsd-kind-icon">IAuthenticate<wbr/>Response</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IAuthenticateUserRequest.html" class="tsd-kind-icon">IAuthenticate<wbr/>User<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.ICreateProfileRequest.html" class="tsd-kind-icon">ICreate<wbr/>Profile<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IPermission.html" class="tsd-kind-icon">IPermission</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IProfile.html" class="tsd-kind-icon">IProfile</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IRole.html" class="tsd-kind-icon">IRole</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.ISwitchProfileResponse.html" class="tsd-kind-icon">ISwitch<wbr/>Profile<wbr/>Response</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.IUpdateProfileRequest.html" class="tsd-kind-icon">IUpdate<wbr/>Profile<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.TokenValidationRequest.html" class="tsd-kind-icon">Token<wbr/>Validation<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.TokenValidationResponse.html" class="tsd-kind-icon">Token<wbr/>Validation<wbr/>Response</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.UpdateEmailRequest.html" class="tsd-kind-icon">Update<wbr/>Email<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.UpdateEmailResponse.html" class="tsd-kind-icon">Update<wbr/>Email<wbr/>Response</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.UpdatePasswordRequest.html" class="tsd-kind-icon">Update<wbr/>Password<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Users.Types.UpdatePasswordResponse.html" class="tsd-kind-icon">Update<wbr/>Password<wbr/>Response</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Users.Types.html#TPermission" class="tsd-kind-icon">TPermission</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Users.Types.html#TPlan" class="tsd-kind-icon">TPlan</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Users.Types.html#TRole" class="tsd-kind-icon">TRole</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs-html/modules/Users.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Users | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Users.html">Users</a></li></ul><h1>Namespace Users</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Namespaces</h3><ul class="tsd-index-list"><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Auth.html" class="tsd-kind-icon">Auth</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Billing.html" class="tsd-kind-icon">Billing</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Notifications.html" class="tsd-kind-icon">Notifications</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Profiles.html" class="tsd-kind-icon">Profiles</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Types.html" class="tsd-kind-icon">Types</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class="current tsd-kind-namespace"><a href="Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Profiles.html">Profiles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Types.html">Types</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs-html/modules/Utils.DateTime.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>DateTime | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Utils.html">Utils</a></li><li><a href="Utils.DateTime.html">DateTime</a></li></ul><h1>Namespace DateTime</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Utils.DateTime.html#formatShortTimeAgo" class="tsd-kind-icon">format<wbr/>Short<wbr/>Time<wbr/>Ago</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="formatShortTimeAgo" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> format<wbr/>Short<wbr/>Time<wbr/>Ago</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">format<wbr/>Short<wbr/>Time<wbr/>Ago<span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Utils/DateTime.ts#L8">Utils/DateTime.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>val: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class="current tsd-kind-namespace"><a href="Utils.html">Utils</a><ul><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Utils.DateTime.html">Date<wbr/>Time</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Utils.DateTime.html#formatShortTimeAgo" class="tsd-kind-icon">format<wbr/>Short<wbr/>Time<wbr/>Ago</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs-html/modules/Utils.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Utils | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Utils.html">Utils</a></li></ul><h1>Namespace Utils</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Namespaces</h3><ul class="tsd-index-list"><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Utils.DateTime.html" class="tsd-kind-icon">Date<wbr/>Time</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class="current tsd-kind-namespace"><a href="Utils.html">Utils</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Utils.DateTime.html">Date<wbr/>Time</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs-html/modules/Validators.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Validators | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Validators.html">Validators</a></li></ul><h1>Namespace Validators</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Validators.IValidator.html" class="tsd-kind-icon">IValidator</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Validators.html#getValidator" class="tsd-kind-icon">get<wbr/>Validator</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Validators.html#getValidators" class="tsd-kind-icon">get<wbr/>Validators</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getValidator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Validator</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Validator<span class="tsd-signature-symbol">(</span>validatorName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Validators.IValidator.html" class="tsd-signature-type" data-tsd-kind="Interface">IValidator</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Validators.ts#L13">Validators.ts:13</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>validatorName: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Validators.IValidator.html" class="tsd-signature-type" data-tsd-kind="Interface">IValidator</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getValidators" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Validators</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Validators<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Validators.IValidator.html" class="tsd-signature-type" data-tsd-kind="Interface">IValidator</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Validators.ts#L8">Validators.ts:8</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Validators.IValidator.html" class="tsd-signature-type" data-tsd-kind="Interface">IValidator</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class="current tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Validators.IValidator.html" class="tsd-kind-icon">IValidator</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Validators.html#getValidator" class="tsd-kind-icon">get<wbr/>Validator</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Validators.html#getValidators" class="tsd-kind-icon">get<wbr/>Validators</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs-html/modules/Whitelabel.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Whitelabel | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Whitelabel.html">Whitelabel</a></li></ul><h1>Namespace Whitelabel</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Whitelabel.html#createWhitelabel" class="tsd-kind-icon">create<wbr/>Whitelabel</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Whitelabel.html#getWhitelabel" class="tsd-kind-icon">get<wbr/>Whitelabel</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="createWhitelabel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Whitelabel</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Whitelabel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Whitelabel.ts#L3">Whitelabel.ts:3</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getWhitelabel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Whitelabel</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Whitelabel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Whitelabel.ts#L8">Whitelabel.ts:8</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class="current tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Whitelabel.html#createWhitelabel" class="tsd-kind-icon">create<wbr/>Whitelabel</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Whitelabel.html#getWhitelabel" class="tsd-kind-icon">get<wbr/>Whitelabel</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs-html/modules.html ADDED
@@ -0,0 +1,11 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>@verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>@verdocs/js-sdk - v1.0.12</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Verdocs functions are organized into high-level modules that represent the main objects within Verdocs:</p>
3
+ </div><div><ul>
4
+ <li>Documents - An individual document to be signed. Documents are created from templates.</li>
5
+ <li>HTTP - General support functionality for Verdocs&#39; REST endpoints. Typically not used directly.</li>
6
+ <li>Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.</li>
7
+ <li>Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.</li>
8
+ <li>Users - All operations related to authentication and user-related operations.</li>
9
+ <li>Utils - General support functions used by the other modules and exported for convenience.</li>
10
+ </ul>
11
+ </div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Namespaces</h3><ul class="tsd-index-list"><li class="tsd-kind-namespace"><a href="modules/Documents.html" class="tsd-kind-icon">Documents</a></li><li class="tsd-kind-namespace"><a href="modules/HTTP.html" class="tsd-kind-icon">HTTP</a></li><li class="tsd-kind-namespace"><a href="modules/Organizations.html" class="tsd-kind-icon">Organizations</a></li><li class="tsd-kind-namespace"><a href="modules/Signatures.html" class="tsd-kind-icon">Signatures</a></li><li class="tsd-kind-namespace"><a href="modules/Tags.html" class="tsd-kind-icon">Tags</a></li><li class="tsd-kind-namespace"><a href="modules/Templates.html" class="tsd-kind-icon">Templates</a></li><li class="tsd-kind-namespace"><a href="modules/Users.html" class="tsd-kind-icon">Users</a></li><li class="tsd-kind-namespace"><a href="modules/Utils.html" class="tsd-kind-icon">Utils</a></li><li class="tsd-kind-namespace"><a href="modules/Validators.html" class="tsd-kind-icon">Validators</a></li><li class="tsd-kind-namespace"><a href="modules/Whitelabel.html" class="tsd-kind-icon">Whitelabel</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="modules/HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="modules/Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="modules/Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="modules/Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="modules/Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="modules/Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="modules/Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="modules/Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="modules/Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
package/jestconfig.json ADDED
@@ -0,0 +1,11 @@
1
+ {
2
+ "transform": {
3
+ "^.+\\.(t|j)sx?$": "ts-jest"
4
+ },
5
+ "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
6
+ "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
7
+ "collectCoverage": true,
8
+ "coverageDirectory": "<rootDir>/../reports/coverage",
9
+ "coveragePathIgnorePatterns": ["config"],
10
+ "coverageReporters": ["json", "lcov", "text", "html"]
11
+ }