@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/interfaces/Users.Types.TokenValidationResponse.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TokenValidationResponse | @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="../modules/Users.html">Users</a></li><li><a href="../modules/Users.Types.html">Types</a></li><li><a href="Users.Types.TokenValidationResponse.html">TokenValidationResponse</a></li></ul><h1>Interface TokenValidationResponse</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">TokenValidationResponse</span></li></ul></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.TokenValidationResponse.html#payload" class="tsd-kind-icon">payload</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.TokenValidationResponse.html#valid" class="tsd-kind-icon">valid</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="payload" class="tsd-anchor"></a><h3>payload</h3><div class="tsd-signature tsd-kind-icon">payload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L135">Users/Types.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>The decoded and validated body of the JWT</p>
3
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="valid" class="tsd-anchor"></a><h3>valid</h3><div class="tsd-signature tsd-kind-icon">valid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L133">Users/Types.ts:133</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>True if the token is valid</p>
5
+ </div></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="../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="current tsd-kind-namespace"><a href="../modules/Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Profiles.html">Profiles</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Types.html">Types</a></li></ul></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><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="Users.Types.TokenValidationResponse.html" class="tsd-kind-icon">Token<wbr/>Validation<wbr/>Response</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.TokenValidationResponse.html#payload" class="tsd-kind-icon">payload</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.TokenValidationResponse.html#valid" class="tsd-kind-icon">valid</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><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/interfaces/Users.Types.UpdateEmailRequest.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>UpdateEmailRequest | @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="../modules/Users.html">Users</a></li><li><a href="../modules/Users.Types.html">Types</a></li><li><a href="Users.Types.UpdateEmailRequest.html">UpdateEmailRequest</a></li></ul><h1>Interface UpdateEmailRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">UpdateEmailRequest</span></li></ul></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdateEmailRequest.html#email" class="tsd-kind-icon">email</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="email" class="tsd-anchor"></a><h3>email</h3><div class="tsd-signature tsd-kind-icon">email<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L151">Users/Types.ts:151</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="../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="current tsd-kind-namespace"><a href="../modules/Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Profiles.html">Profiles</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Types.html">Types</a></li></ul></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><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="Users.Types.UpdateEmailRequest.html" class="tsd-kind-icon">Update<wbr/>Email<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdateEmailRequest.html#email" class="tsd-kind-icon">email</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><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/interfaces/Users.Types.UpdateEmailResponse.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>UpdateEmailResponse | @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="../modules/Users.html">Users</a></li><li><a href="../modules/Users.Types.html">Types</a></li><li><a href="Users.Types.UpdateEmailResponse.html">UpdateEmailResponse</a></li></ul><h1>Interface UpdateEmailResponse</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">UpdateEmailResponse</span></li></ul></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdateEmailResponse.html#profiles" class="tsd-kind-icon">profiles</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="profiles" class="tsd-anchor"></a><h3>profiles</h3><div class="tsd-signature tsd-kind-icon">profiles<span class="tsd-signature-symbol">:</span> <a href="Users.Types.IProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">IProfile</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L155">Users/Types.ts:155</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="../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="current tsd-kind-namespace"><a href="../modules/Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Profiles.html">Profiles</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Types.html">Types</a></li></ul></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><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="Users.Types.UpdateEmailResponse.html" class="tsd-kind-icon">Update<wbr/>Email<wbr/>Response</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdateEmailResponse.html#profiles" class="tsd-kind-icon">profiles</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><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/interfaces/Users.Types.UpdatePasswordRequest.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>UpdatePasswordRequest | @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="../modules/Users.html">Users</a></li><li><a href="../modules/Users.Types.html">Types</a></li><li><a href="Users.Types.UpdatePasswordRequest.html">UpdatePasswordRequest</a></li></ul><h1>Interface UpdatePasswordRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">UpdatePasswordRequest</span></li></ul></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordRequest.html#email" class="tsd-kind-icon">email</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordRequest.html#newPassword" class="tsd-kind-icon">new<wbr/>Password</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordRequest.html#oldPassword" class="tsd-kind-icon">old<wbr/>Password</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="email" class="tsd-anchor"></a><h3>email</h3><div class="tsd-signature tsd-kind-icon">email<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L139">Users/Types.ts:139</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="newPassword" class="tsd-anchor"></a><h3>new<wbr/>Password</h3><div class="tsd-signature tsd-kind-icon">new<wbr/>Password<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L141">Users/Types.ts:141</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="oldPassword" class="tsd-anchor"></a><h3>old<wbr/>Password</h3><div class="tsd-signature tsd-kind-icon">old<wbr/>Password<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L140">Users/Types.ts:140</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="../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="current tsd-kind-namespace"><a href="../modules/Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Profiles.html">Profiles</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Types.html">Types</a></li></ul></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><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="Users.Types.UpdatePasswordRequest.html" class="tsd-kind-icon">Update<wbr/>Password<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordRequest.html#email" class="tsd-kind-icon">email</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordRequest.html#newPassword" class="tsd-kind-icon">new<wbr/>Password</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordRequest.html#oldPassword" class="tsd-kind-icon">old<wbr/>Password</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><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/interfaces/Users.Types.UpdatePasswordResponse.html ADDED
@@ -0,0 +1,3 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>UpdatePasswordResponse | @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="../modules/Users.html">Users</a></li><li><a href="../modules/Users.Types.html">Types</a></li><li><a href="Users.Types.UpdatePasswordResponse.html">UpdatePasswordResponse</a></li></ul><h1>Interface UpdatePasswordResponse</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">UpdatePasswordResponse</span></li></ul></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordResponse.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordResponse.html#status" class="tsd-kind-icon">status</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="message" class="tsd-anchor"></a><h3>message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L147">Users/Types.ts:147</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Success or failure message</p>
3
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="status" class="tsd-anchor"></a><h3>status</h3><div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <a href="../modules/HTTP.Types.html#TRequestStatus" class="tsd-signature-type" data-tsd-kind="Type alias">TRequestStatus</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L145">Users/Types.ts:145</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="../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="current tsd-kind-namespace"><a href="../modules/Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Profiles.html">Profiles</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/Users.Types.html">Types</a></li></ul></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><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="Users.Types.UpdatePasswordResponse.html" class="tsd-kind-icon">Update<wbr/>Password<wbr/>Response</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordResponse.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Users.Types.UpdatePasswordResponse.html#status" class="tsd-kind-icon">status</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><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/interfaces/Validators.IValidator.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>IValidator | @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="../modules/Validators.html">Validators</a></li><li><a href="Validators.IValidator.html">IValidator</a></li></ul><h1>Interface IValidator</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IValidator</span></li></ul></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Validators.IValidator.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Validators.IValidator.html#regex" class="tsd-kind-icon">regex</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Validators.ts#L4">Validators.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="regex" class="tsd-anchor"></a><h3>regex</h3><div class="tsd-signature tsd-kind-icon">regex<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Validators.ts#L5">Validators.ts:5</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="../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="current 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><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="Validators.IValidator.html" class="tsd-kind-icon">IValidator</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Validators.IValidator.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Validators.IValidator.html#regex" class="tsd-kind-icon">regex</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><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/Documents.Documents-1.html ADDED
@@ -0,0 +1,9 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Documents | @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="Documents.html">Documents</a></li><li><a href="Documents.Documents-1.html">Documents</a></li></ul><h1>Namespace Documents</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/Documents.Documents-1.IActivityEntry.html" class="tsd-kind-icon">IActivity<wbr/>Entry</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocument.html" class="tsd-kind-icon">IDocument</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocumentSearchOptions.html" class="tsd-kind-icon">IDocument<wbr/>Search<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocumentsSearchResult.html" class="tsd-kind-icon">IDocuments<wbr/>Search<wbr/>Result</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.html" class="tsd-kind-icon">IDocuments<wbr/>Search<wbr/>Result<wbr/>Entry</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocumentsSummary.html" class="tsd-kind-icon">IDocuments<wbr/>Summary</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IHistory.html" class="tsd-kind-icon">IHistory</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IRecipient.html" class="tsd-kind-icon">IRecipient</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="Documents.Documents-1.html#IDocumentStatus" class="tsd-kind-icon">IDocument<wbr/>Status</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#IEventDetail" class="tsd-kind-icon">IEvent<wbr/>Detail</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#IHistoryEvent" class="tsd-kind-icon">IHistory<wbr/>Event</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#IRecipientStatus" class="tsd-kind-icon">IRecipient<wbr/>Status</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#IRecipientType" class="tsd-kind-icon">IRecipient<wbr/>Type</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="Documents.Documents-1.html#getSummary" class="tsd-kind-icon">get<wbr/>Summary</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#search" class="tsd-kind-icon">search</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="IDocumentStatus" class="tsd-anchor"></a><h3>IDocument<wbr/>Status</h3><div class="tsd-signature tsd-kind-icon">IDocument<wbr/>Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;complete&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;pending&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;progress&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L3">Documents/Documents.ts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="IEventDetail" class="tsd-anchor"></a><h3>IEvent<wbr/>Detail</h3><div class="tsd-signature tsd-kind-icon">IEvent<wbr/>Detail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;in_app&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;mail&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;signer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L138">Documents/Documents.ts:138</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="IHistoryEvent" class="tsd-anchor"></a><h3>IHistory<wbr/>Event</h3><div class="tsd-signature tsd-kind-icon">IHistory<wbr/>Event<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;recipient:invited&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;recipient:opened&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;recipient:agreed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;recipient:signed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;recipient:submitted&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L131">Documents/Documents.ts:131</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="IRecipientStatus" class="tsd-anchor"></a><h3>IRecipient<wbr/>Status</h3><div class="tsd-signature tsd-kind-icon">IRecipient<wbr/>Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;invited&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;opened&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;signed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;submitted&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L5">Documents/Documents.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a name="IRecipientType" class="tsd-anchor"></a><h3>IRecipient<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">IRecipient<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;signer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;cc&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L7">Documents/Documents.ts:7</a></li></ul></aside></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="getSummary" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Summary</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Summary<span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Documents.Documents-1.IDocumentsSummary.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocumentsSummary</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/Documents/Documents.ts#L149">Documents/Documents.ts:149</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Get a summary of currently active documents.</p>
3
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Documents</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/Documents&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> {</span><span class="hl-5">action_required</span><span class="hl-1">, </span><span class="hl-5">completed</span><span class="hl-1">, </span><span class="hl-5">waiting_on_others</span><span class="hl-1">} = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Documents</span><span class="hl-1">.</span><span class="hl-6">getSummary</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>page: <span class="tsd-signature-type">number</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/Documents.Documents-1.IDocumentsSummary.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocumentsSummary</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="search" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> search</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">search<span class="tsd-signature-symbol">(</span>params<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Documents.Documents-1.IDocumentsSearchResult.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocumentsSearchResult</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/Documents/Documents.ts#L163">Documents/Documents.ts:163</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>Search for documents matching various criteria.</p>
7
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Documents</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/Documents&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> {</span><span class="hl-5">result</span><span class="hl-1">, </span><span class="hl-5">page</span><span class="hl-1">, </span><span class="hl-5">total</span><span class="hl-1">} = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Documents</span><span class="hl-1">.</span><span class="hl-6">search</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>params: <span class="tsd-signature-type">any</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/Documents.Documents-1.IDocumentsSearchResult.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocumentsSearchResult</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="current tsd-kind-namespace"><a href="Documents.html">Documents</a><ul><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Documents-1.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Templates.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Types.html">Types</a></li></ul></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=" 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/Documents.Documents-1.IActivityEntry.html" class="tsd-kind-icon">IActivity<wbr/>Entry</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocument.html" class="tsd-kind-icon">IDocument</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocumentSearchOptions.html" class="tsd-kind-icon">IDocument<wbr/>Search<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocumentsSearchResult.html" class="tsd-kind-icon">IDocuments<wbr/>Search<wbr/>Result</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.html" class="tsd-kind-icon">IDocuments<wbr/>Search<wbr/>Result<wbr/>Entry</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IDocumentsSummary.html" class="tsd-kind-icon">IDocuments<wbr/>Summary</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IHistory.html" class="tsd-kind-icon">IHistory</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Documents-1.IRecipient.html" class="tsd-kind-icon">IRecipient</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#IDocumentStatus" class="tsd-kind-icon">IDocument<wbr/>Status</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#IEventDetail" class="tsd-kind-icon">IEvent<wbr/>Detail</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#IHistoryEvent" class="tsd-kind-icon">IHistory<wbr/>Event</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#IRecipientStatus" class="tsd-kind-icon">IRecipient<wbr/>Status</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#IRecipientType" class="tsd-kind-icon">IRecipient<wbr/>Type</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#getSummary" class="tsd-kind-icon">get<wbr/>Summary</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Documents.Documents-1.html#search" class="tsd-kind-icon">search</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/Documents.Stars.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>Stars | @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="Documents.html">Documents</a></li><li><a href="Documents.Stars.html">Stars</a></li></ul><h1>Namespace Stars</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="Documents.Stars.html#toggleStar" class="tsd-kind-icon">toggle<wbr/>Star</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="toggleStar" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> toggle<wbr/>Star</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">toggle<wbr/>Star<span class="tsd-signature-symbol">(</span>templateId<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/Documents.Types.ITemplateSummaryEntry.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplateSummaryEntry</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/Documents/Stars.ts#L4">Documents/Stars.ts:4</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>templateId: <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/Documents.Types.ITemplateSummaryEntry.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplateSummaryEntry</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="current tsd-kind-namespace"><a href="Documents.html">Documents</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Documents-1.html">Documents</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Templates.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Types.html">Types</a></li></ul></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=" 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="Documents.Stars.html#toggleStar" class="tsd-kind-icon">toggle<wbr/>Star</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/Documents.Templates.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>Templates | @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="Documents.html">Documents</a></li><li><a href="Documents.Templates.html">Templates</a></li></ul><h1>Namespace Templates</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="Documents.Templates.html#getSummary" class="tsd-kind-icon">get<wbr/>Summary</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Documents.Templates.html#getTemplates" class="tsd-kind-icon">get<wbr/>Templates</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Documents.Templates.html#searchTemplates" class="tsd-kind-icon">search<wbr/>Templates</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="getSummary" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Summary</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Summary<span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Documents.Types.ITemplatesSummary.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplatesSummary</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/Documents/Templates.ts#L14">Documents/Templates.ts:14</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>page: <span class="tsd-signature-type">number</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/Documents.Types.ITemplatesSummary.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplatesSummary</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="getTemplates" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Templates</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Templates<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/Documents/Templates.ts#L4">Documents/Templates.ts:4</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="searchTemplates" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> search<wbr/>Templates</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">search<wbr/>Templates<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/Documents/Templates.ts#L9">Documents/Templates.ts:9</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="current tsd-kind-namespace"><a href="Documents.html">Documents</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Documents-1.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Stars.html">Stars</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Templates.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Types.html">Types</a></li></ul></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=" 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="Documents.Templates.html#getSummary" class="tsd-kind-icon">get<wbr/>Summary</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Documents.Templates.html#getTemplates" class="tsd-kind-icon">get<wbr/>Templates</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Documents.Templates.html#searchTemplates" class="tsd-kind-icon">search<wbr/>Templates</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/Documents.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="Documents.html">Documents</a></li><li><a href="Documents.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/Documents.Types.ITemplateSummaryEntry.html" class="tsd-kind-icon">ITemplate<wbr/>Summary<wbr/>Entry</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Types.ITemplatesSummary.html" class="tsd-kind-icon">ITemplates<wbr/>Summary</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="current tsd-kind-namespace"><a href="Documents.html">Documents</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Documents-1.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Templates.html">Templates</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Types.html">Types</a></li></ul></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=" 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/Documents.Types.ITemplateSummaryEntry.html" class="tsd-kind-icon">ITemplate<wbr/>Summary<wbr/>Entry</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Documents.Types.ITemplatesSummary.html" class="tsd-kind-icon">ITemplates<wbr/>Summary</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/Documents.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>Documents | @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="Documents.html">Documents</a></li></ul><h1>Namespace Documents</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="Documents.Documents-1.html" class="tsd-kind-icon">Documents</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Stars.html" class="tsd-kind-icon">Stars</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Templates.html" class="tsd-kind-icon">Templates</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.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="current tsd-kind-namespace"><a href="Documents.html">Documents</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Documents-1.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Templates.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Documents.Types.html">Types</a></li></ul></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=" 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/HTTP.Transport.html ADDED
@@ -0,0 +1,22 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Transport | @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="HTTP.html">HTTP</a></li><li><a href="HTTP.Transport.html">Transport</a></li></ul><h1>Namespace Transport</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="HTTP.Transport.html#getEndpoint" class="tsd-kind-icon">get<wbr/>Endpoint</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="HTTP.Transport.html#setAuthorization" class="tsd-kind-icon">set<wbr/>Authorization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="HTTP.Transport.html#setBaseUrl" class="tsd-kind-icon">set<wbr/>Base<wbr/>Url</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="HTTP.Transport.html#setClientID" class="tsd-kind-icon">set<wbr/>ClientID</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="HTTP.Transport.html#setTimeout" class="tsd-kind-icon">set<wbr/>Timeout</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="getEndpoint" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Endpoint</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Endpoint<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosInstance</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/HTTP/Transport.ts#L89">HTTP/Transport.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Helper to get the endpoint for direct access to HTTP functions.</p>
3
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Transport</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/HTTP&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-3">&#39;Current timeout&#39;</span><span class="hl-1">, </span><span class="hl-0">Transport</span><span class="hl-1">.</span><span class="hl-6">getEndpoint</span><span class="hl-1">().</span><span class="hl-0">defaults</span><span class="hl-1">.</span><span class="hl-0">timeout</span><span class="hl-1">);</span>
4
+ </code></pre>
5
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosInstance</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="setAuthorization" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> set<wbr/>Authorization</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">set<wbr/>Authorization<span class="tsd-signature-symbol">(</span>accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><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">void</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/HTTP/Transport.ts#L19">HTTP/Transport.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>Set the auth token that will be used for Verdocs API calls.</p>
7
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Transport</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/HTTP&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">Transport</span><span class="hl-1">.</span><span class="hl-6">setAuthorization</span><span class="hl-1">(</span><span class="hl-0">accessToken</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>accessToken: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="setBaseUrl" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> set<wbr/>Base<wbr/>Url</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">set<wbr/>Base<wbr/>Url<span class="tsd-signature-symbol">(</span>baseUrl<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">void</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/HTTP/Transport.ts#L57">HTTP/Transport.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>Set the base URL for API calls. Typically this is <a href="https://api.verdocs.com/">https://api.verdocs.com/</a> and is the default. Change this only after consultation
11
+ with Verdocs Developer Support.</p>
12
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Transport</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/HTTP&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">Transport</span><span class="hl-1">.</span><span class="hl-6">setBaseUrl</span><span class="hl-1">(</span><span class="hl-3">&#39;https://api.verdiocs.com&#39;</span><span class="hl-1">);</span>
13
+ </code></pre>
14
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>baseUrl: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="setClientID" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> set<wbr/>ClientID</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">set<wbr/>ClientID<span class="tsd-signature-symbol">(</span>clientID<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">void</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/HTTP/Transport.ts#L40">HTTP/Transport.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
15
+ <p>Set the Client ID for Verdocs API calls.</p>
16
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Transport</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/HTTP&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">Transport</span><span class="hl-1">.</span><span class="hl-6">setClientID</span><span class="hl-1">(</span><span class="hl-3">&#39;1234)</span><span class="hl-8">;</span>
17
+ </code></pre>
18
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>clientID: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="setTimeout" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> set<wbr/>Timeout</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">set<wbr/>Timeout<span class="tsd-signature-symbol">(</span>timeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/HTTP/Transport.ts#L73">HTTP/Transport.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>Set the timeout for API calls in milliseconds. 2000-4000ms is recommended for most purposes. 3000ms is the default.</p>
20
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Transport</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/HTTP&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">Transport</span><span class="hl-1">.</span><span class="hl-6">setTimeout</span><span class="hl-1">(</span><span class="hl-7">3000</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>timeout: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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="current tsd-kind-namespace"><a href="HTTP.html">HTTP</a><ul><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="HTTP.Transport.html">Transport</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="HTTP.Types.html">Types</a></li></ul></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=" 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="HTTP.Transport.html#getEndpoint" class="tsd-kind-icon">get<wbr/>Endpoint</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="HTTP.Transport.html#setAuthorization" class="tsd-kind-icon">set<wbr/>Authorization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="HTTP.Transport.html#setBaseUrl" class="tsd-kind-icon">set<wbr/>Base<wbr/>Url</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="HTTP.Transport.html#setClientID" class="tsd-kind-icon">set<wbr/>ClientID</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="HTTP.Transport.html#setTimeout" class="tsd-kind-icon">set<wbr/>Timeout</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/HTTP.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="HTTP.html">HTTP</a></li><li><a href="HTTP.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>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="HTTP.Types.html#TRequestStatus" class="tsd-kind-icon">TRequest<wbr/>Status</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="TRequestStatus" class="tsd-anchor"></a><h3>TRequest<wbr/>Status</h3><div class="tsd-signature tsd-kind-icon">TRequest<wbr/>Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;OK&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ERROR&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/HTTP/Types.ts#L1">HTTP/Types.ts:1</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="current tsd-kind-namespace"><a href="HTTP.html">HTTP</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="HTTP.Transport.html">Transport</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="HTTP.Types.html">Types</a></li></ul></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=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="HTTP.Types.html#TRequestStatus" class="tsd-kind-icon">TRequest<wbr/>Status</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/HTTP.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>HTTP | @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="HTTP.html">HTTP</a></li></ul><h1>Namespace HTTP</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="HTTP.Transport.html" class="tsd-kind-icon">Transport</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="HTTP.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="current tsd-kind-namespace"><a href="HTTP.html">HTTP</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="HTTP.Transport.html">Transport</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="HTTP.Types.html">Types</a></li></ul></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=" 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/Organizations.ApiKeys.html ADDED
@@ -0,0 +1,29 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ApiKeys | @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="Organizations.html">Organizations</a></li><li><a href="Organizations.ApiKeys.html">ApiKeys</a></li></ul><h1>Namespace ApiKeys</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>API keys are used to authenticate server-to-server calls. (API keys should <strong>never</strong> be used for client-to-server operations!)
3
+ To generate a key, either use the Verdocs admin interface and make note of the client_id and client_secret generated, or call
4
+ createKey as shown below. Then call <a href="Users.Auth.html#authenticateApp">Users.Auth.authenticateApp</a> to obtain an access token using the provided ID and
5
+ secret. Note that server-to-server authentication requests return shorter-lived tokens, so it is important to check the <code>exp</code>
6
+ field and re-authenticate as needed for subsequent calls.</p>
7
+ </div><div><p>API keys may be updated or rotated at any time. Regular rotation is recommended. Rotation will not expire or invalidate
8
+ existing server-to-server sessions, so it may be done at any time without disrupting your application.</p>
9
+ </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>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html#createKey" class="tsd-kind-icon">create<wbr/>Key</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html#deleteKey" class="tsd-kind-icon">delete<wbr/>Key</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html#getKeys" class="tsd-kind-icon">get<wbr/>Keys</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html#rotateKey" class="tsd-kind-icon">rotate<wbr/>Key</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html#updateKey" class="tsd-kind-icon">update<wbr/>Key</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="createKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Key<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Organizations.Types.ICreateApiKeyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ICreateApiKeyRequest</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/Organizations.Types.IApiKeyWithSecret.html" class="tsd-signature-type" data-tsd-kind="Interface">IApiKeyWithSecret</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/Organizations/ApiKeys.ts#L40">Organizations/ApiKeys.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>Create an API key.</p>
11
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">ApiKeys</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/Organizations&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">ApiKeys</span><span class="hl-1">.</span><span class="hl-6">createKey</span><span class="hl-1">(</span><span class="hl-5">ORGID</span><span class="hl-1">, {</span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-5">NEWNAME</span><span class="hl-1">});</span>
12
+ </code></pre>
13
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>params: <a href="../interfaces/Organizations.Types.ICreateApiKeyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ICreateApiKeyRequest</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/Organizations.Types.IApiKeyWithSecret.html" class="tsd-signature-type" data-tsd-kind="Interface">IApiKeyWithSecret</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="deleteKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Key<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientId<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/Organizations/ApiKeys.ts#L82">Organizations/ApiKeys.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>Delete an API key.</p>
15
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">ApiKeys</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/Organizations&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">ApiKeys</span><span class="hl-1">.</span><span class="hl-6">deleteKey</span><span class="hl-1">(</span><span class="hl-5">ORGID</span><span class="hl-1">, </span><span class="hl-5">CLIENTID</span><span class="hl-1">);</span>
16
+ </code></pre>
17
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>clientId: <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="getKeys" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Keys</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Keys<span class="tsd-signature-symbol">(</span>organizationId<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.IApiKey.html" class="tsd-signature-type" data-tsd-kind="Interface">IApiKey</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/Organizations/ApiKeys.ts#L26">Organizations/ApiKeys.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
18
+ <p>Get a list of keys for a given organization. The caller must have admin access to the organization.</p>
19
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">ApiKeys</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/Organizations&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">keys</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">ApiKeys</span><span class="hl-1">.</span><span class="hl-6">getKeys</span><span class="hl-1">(</span><span class="hl-5">ORGID</span><span class="hl-1">);</span>
20
+ </code></pre>
21
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <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.IApiKey.html" class="tsd-signature-type" data-tsd-kind="Interface">IApiKey</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="rotateKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> rotate<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">rotate<wbr/>Key<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientId<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.IApiKeyWithSecret.html" class="tsd-signature-type" data-tsd-kind="Interface">IApiKeyWithSecret</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/Organizations/ApiKeys.ts#L54">Organizations/ApiKeys.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
22
+ <p>Rotate the secret for an API key. The caller must have admin access to the organization.</p>
23
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">ApiKeys</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/Organizations&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> {</span><span class="hl-0">client_secret</span><span class="hl-1">: </span><span class="hl-5">newSecret</span><span class="hl-1">} = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">ApiKeys</span><span class="hl-1">.</span><span class="hl-6">rotateKey</span><span class="hl-1">(</span><span class="hl-5">ORGID</span><span class="hl-1">, </span><span class="hl-5">CLIENTID</span><span class="hl-1">);</span>
24
+ </code></pre>
25
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>clientId: <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.IApiKeyWithSecret.html" class="tsd-signature-type" data-tsd-kind="Interface">IApiKeyWithSecret</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="updateKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> update<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">update<wbr/>Key<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Organizations.Types.IUpdateApiKeyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">IUpdateApiKeyRequest</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/Organizations.Types.IApiKey.html" class="tsd-signature-type" data-tsd-kind="Interface">IApiKey</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/Organizations/ApiKeys.ts#L68">Organizations/ApiKeys.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
26
+ <p>Update an API key to change its assigned Profile ID or Name.</p>
27
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">ApiKeys</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/Organizations&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">ApiKeys</span><span class="hl-1">.</span><span class="hl-6">updateKey</span><span class="hl-1">(</span><span class="hl-5">ORGID</span><span class="hl-1">, </span><span class="hl-5">CLIENTID</span><span class="hl-1">, {</span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-5">NEWNAME</span><span class="hl-1">});</span>
28
+ </code></pre>
29
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>clientId: <span class="tsd-signature-type">string</span></h5></li><li><h5>params: <a href="../interfaces/Organizations.Types.IUpdateApiKeyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">IUpdateApiKeyRequest</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/Organizations.Types.IApiKey.html" class="tsd-signature-type" data-tsd-kind="Interface">IApiKey</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="current tsd-kind-namespace"><a href="Organizations.html">Organizations</a><ul><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html">Api<wbr/>Keys</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Groups.html">Groups</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Invitations.html">Invitations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Members.html">Members</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html">Organizations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Types.html">Types</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html">Webhooks</a></li></ul></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=" 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="Organizations.ApiKeys.html#createKey" class="tsd-kind-icon">create<wbr/>Key</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html#deleteKey" class="tsd-kind-icon">delete<wbr/>Key</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html#getKeys" class="tsd-kind-icon">get<wbr/>Keys</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html#rotateKey" class="tsd-kind-icon">rotate<wbr/>Key</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html#updateKey" class="tsd-kind-icon">update<wbr/>Key</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>