@verdocs/js-sdk 1.0.11 → 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 (360) 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/__mocks__/axios.ts +3 -0
  11. package/dist/.npmignore +5 -0
  12. package/{Documents → dist/Documents}/Documents.d.ts +9 -0
  13. package/{Documents → dist/Documents}/Documents.js +24 -7
  14. package/{Documents → dist/Documents}/Stars.d.ts +0 -0
  15. package/{Documents → dist/Documents}/Stars.js +2 -2
  16. package/{Documents → dist/Documents}/Templates.d.ts +0 -0
  17. package/{Documents → dist/Documents}/Templates.js +22 -10
  18. package/{Documents → dist/Documents}/Types.d.ts +0 -0
  19. package/{Documents → dist/Documents}/Types.js +0 -0
  20. package/{Documents → dist/Documents}/index.d.ts +0 -0
  21. package/{Documents → dist/Documents}/index.js +0 -0
  22. package/{HTTP → dist/HTTP}/Transport.d.ts +1 -2
  23. package/{HTTP → dist/HTTP}/Transport.js +29 -11
  24. package/{HTTP → dist/HTTP}/Types.d.ts +0 -0
  25. package/{HTTP → dist/HTTP}/Types.js +0 -0
  26. package/{HTTP → dist/HTTP}/index.d.ts +0 -0
  27. package/{HTTP → dist/HTTP}/index.js +0 -0
  28. package/{Organizations → dist/Organizations}/ApiKeys.d.ts +0 -0
  29. package/{Organizations → dist/Organizations}/ApiKeys.js +16 -6
  30. package/{Organizations → dist/Organizations}/Groups.d.ts +0 -0
  31. package/{Organizations → dist/Organizations}/Groups.js +22 -8
  32. package/{Organizations → dist/Organizations}/Invitations.d.ts +0 -0
  33. package/dist/Organizations/Invitations.js +36 -0
  34. package/{Organizations → dist/Organizations}/Members.d.ts +0 -0
  35. package/dist/Organizations/Members.js +26 -0
  36. package/{Organizations → dist/Organizations}/Organizations.d.ts +0 -0
  37. package/dist/Organizations/Organizations.js +31 -0
  38. package/{Organizations → dist/Organizations}/Types.d.ts +0 -0
  39. package/{Organizations → dist/Organizations}/Types.js +0 -0
  40. package/{Organizations → dist/Organizations}/Webhooks.d.ts +0 -0
  41. package/dist/Organizations/Webhooks.js +11 -0
  42. package/{Organizations → dist/Organizations}/index.d.ts +0 -0
  43. package/{Organizations → dist/Organizations}/index.js +0 -0
  44. package/dist/README.md +68 -0
  45. package/{Search → dist/Search}/Content.d.ts +0 -0
  46. package/{Search → dist/Search}/Content.js +22 -10
  47. package/{Search → dist/Search}/Types.d.ts +0 -0
  48. package/{Search → dist/Search}/Types.js +0 -0
  49. package/{Search → dist/Search}/index.d.ts +0 -0
  50. package/{Search → dist/Search}/index.js +0 -0
  51. package/{Signatures.d.ts → dist/Signatures.d.ts} +0 -0
  52. package/dist/Signatures.js +21 -0
  53. package/{Tags.d.ts → dist/Tags.d.ts} +0 -0
  54. package/dist/Tags.js +16 -0
  55. package/{Templates → dist/Templates}/Documents.d.ts +0 -0
  56. package/{Templates → dist/Templates}/Documents.js +13 -5
  57. package/{Templates → dist/Templates}/Fields.d.ts +0 -0
  58. package/dist/Templates/Fields.js +16 -0
  59. package/{Templates → dist/Templates}/Pages.d.ts +0 -0
  60. package/dist/Templates/Pages.js +21 -0
  61. package/{Templates → dist/Templates}/Reminders.d.ts +0 -0
  62. package/dist/Templates/Reminders.js +21 -0
  63. package/{Templates → dist/Templates}/Roles.d.ts +0 -0
  64. package/dist/Templates/Roles.js +36 -0
  65. package/{Templates → dist/Templates}/Stars.d.ts +0 -0
  66. package/dist/Templates/Stars.js +11 -0
  67. package/{Templates → dist/Templates}/Tags.d.ts +0 -0
  68. package/dist/Templates/Tags.js +16 -0
  69. package/{Templates → dist/Templates}/Templates.d.ts +0 -0
  70. package/{Templates → dist/Templates}/Templates.js +33 -11
  71. package/{Templates → dist/Templates}/Types.d.ts +0 -0
  72. package/{Templates → dist/Templates}/Types.js +0 -0
  73. package/{Templates → dist/Templates}/index.d.ts +0 -0
  74. package/{Templates → dist/Templates}/index.js +0 -0
  75. package/{Users → dist/Users}/Auth.d.ts +0 -0
  76. package/{Users → dist/Users}/Auth.js +21 -7
  77. package/{Users → dist/Users}/Billing.d.ts +0 -0
  78. package/{Users → dist/Users}/Billing.js +0 -0
  79. package/{Users → dist/Users}/Notifications.d.ts +0 -0
  80. package/{Users → dist/Users}/Notifications.js +8 -4
  81. package/{Users → dist/Users}/Profiles.d.ts +0 -0
  82. package/{Users → dist/Users}/Profiles.js +41 -11
  83. package/{Users → dist/Users}/Types.d.ts +13 -0
  84. package/{Users → dist/Users}/Types.js +0 -0
  85. package/{Users → dist/Users}/index.d.ts +0 -0
  86. package/{Users → dist/Users}/index.js +0 -0
  87. package/{Utils → dist/Utils}/DateTime.d.ts +0 -0
  88. package/{Utils → dist/Utils}/DateTime.js +0 -0
  89. package/{Utils → dist/Utils}/index.d.ts +0 -0
  90. package/{Utils → dist/Utils}/index.js +0 -0
  91. package/{Validators.d.ts → dist/Validators.d.ts} +0 -0
  92. package/dist/Validators.js +11 -0
  93. package/{Whitelabel.d.ts → dist/Whitelabel.d.ts} +0 -0
  94. package/dist/Whitelabel.js +11 -0
  95. package/{index.d.ts → dist/index.d.ts} +0 -0
  96. package/{index.js → dist/index.js} +0 -0
  97. package/dist/package.json +64 -0
  98. package/docs/.nojekyll +1 -0
  99. package/docs/README.md +70 -0
  100. package/docs/enums/Templates.Types.SortOptions.md +76 -0
  101. package/docs/enums/Templates.Types.Template.md +153 -0
  102. package/docs/enums/Templates.Types.TemplatePermissions.md +109 -0
  103. package/docs/enums/Templates.Types.TemplateSenderTypes.md +65 -0
  104. package/docs/interfaces/Documents.Documents-1.IActivityEntry.md +120 -0
  105. package/docs/interfaces/Documents.Documents-1.IDocument.md +175 -0
  106. package/docs/interfaces/Documents.Documents-1.IDocumentSearchOptions.md +98 -0
  107. package/docs/interfaces/Documents.Documents-1.IDocumentsSearchResult.md +43 -0
  108. package/docs/interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.md +131 -0
  109. package/docs/interfaces/Documents.Documents-1.IDocumentsSummary.md +67 -0
  110. package/docs/interfaces/Documents.Documents-1.IHistory.md +76 -0
  111. package/docs/interfaces/Documents.Documents-1.IRecipient.md +208 -0
  112. package/docs/interfaces/Documents.Types.ITemplateSummaryEntry.md +186 -0
  113. package/docs/interfaces/Documents.Types.ITemplatesSummary.md +43 -0
  114. package/docs/interfaces/Organizations.Types.IApiKey.md +60 -0
  115. package/docs/interfaces/Organizations.Types.IApiKeyWithSecret.md +87 -0
  116. package/docs/interfaces/Organizations.Types.ICreateApiKeyRequest.md +32 -0
  117. package/docs/interfaces/Organizations.Types.IGroup.md +101 -0
  118. package/docs/interfaces/Organizations.Types.IGroupDetail.md +129 -0
  119. package/docs/interfaces/Organizations.Types.IOrganization.md +128 -0
  120. package/docs/interfaces/Organizations.Types.IUpdateApiKeyRequest.md +32 -0
  121. package/docs/interfaces/Signatures.ISignature.md +65 -0
  122. package/docs/interfaces/Tags.ITags.md +43 -0
  123. package/docs/interfaces/Templates.Types.IDocument.md +109 -0
  124. package/docs/interfaces/Templates.Types.IField.md +109 -0
  125. package/docs/interfaces/Templates.Types.IPage.md +87 -0
  126. package/docs/interfaces/Templates.Types.IReminder.md +109 -0
  127. package/docs/interfaces/Templates.Types.IRole.md +120 -0
  128. package/docs/interfaces/Templates.Types.ISetting.md +98 -0
  129. package/docs/interfaces/Templates.Types.IStar.md +32 -0
  130. package/docs/interfaces/Templates.Types.ITag.md +32 -0
  131. package/docs/interfaces/Templates.Types.ITemplate.md +219 -0
  132. package/docs/interfaces/Templates.Types.ITemplateSearchParams.md +197 -0
  133. package/docs/interfaces/Templates.Types.ITemplateSummaryEntry.md +186 -0
  134. package/docs/interfaces/Templates.Types.ITemplatesSearchResult.md +43 -0
  135. package/docs/interfaces/Templates.Types.ITemplatesSummary.md +43 -0
  136. package/docs/interfaces/Templates.Types.ITimePeriod.md +32 -0
  137. package/docs/interfaces/Users.Types.IActiveSession.md +131 -0
  138. package/docs/interfaces/Users.Types.IAuthenticateAppRequest.md +32 -0
  139. package/docs/interfaces/Users.Types.IAuthenticateResponse.md +43 -0
  140. package/docs/interfaces/Users.Types.IAuthenticateUserRequest.md +32 -0
  141. package/docs/interfaces/Users.Types.ICreateProfileRequest.md +54 -0
  142. package/docs/interfaces/Users.Types.IPermission.md +36 -0
  143. package/docs/interfaces/Users.Types.IProfile.md +173 -0
  144. package/docs/interfaces/Users.Types.IRole.md +36 -0
  145. package/docs/interfaces/Users.Types.ISwitchProfileResponse.md +54 -0
  146. package/docs/interfaces/Users.Types.IUpdateProfileRequest.md +43 -0
  147. package/docs/interfaces/Users.Types.TokenValidationRequest.md +21 -0
  148. package/docs/interfaces/Users.Types.TokenValidationResponse.md +36 -0
  149. package/docs/interfaces/Users.Types.UpdateEmailRequest.md +21 -0
  150. package/docs/interfaces/Users.Types.UpdateEmailResponse.md +21 -0
  151. package/docs/interfaces/Users.Types.UpdatePasswordRequest.md +43 -0
  152. package/docs/interfaces/Users.Types.UpdatePasswordResponse.md +34 -0
  153. package/docs/interfaces/Validators.IValidator.md +32 -0
  154. package/docs/modules/Documents.Documents-1.md +137 -0
  155. package/docs/modules/Documents.Stars.md +31 -0
  156. package/docs/modules/Documents.Templates.md +61 -0
  157. package/docs/modules/Documents.Types.md +12 -0
  158. package/docs/modules/Documents.md +12 -0
  159. package/docs/modules/HTTP.Transport.md +150 -0
  160. package/docs/modules/HTTP.Types.md +21 -0
  161. package/docs/modules/HTTP.md +10 -0
  162. package/docs/modules/Organizations.ApiKeys.md +169 -0
  163. package/docs/modules/Organizations.Groups.md +190 -0
  164. package/docs/modules/Organizations.Invitations.md +166 -0
  165. package/docs/modules/Organizations.Members.md +121 -0
  166. package/docs/modules/Organizations.Organizations-1.md +119 -0
  167. package/docs/modules/Organizations.Types.md +17 -0
  168. package/docs/modules/Organizations.Webhooks.md +53 -0
  169. package/docs/modules/Organizations.md +20 -0
  170. package/docs/modules/Signatures.md +90 -0
  171. package/docs/modules/Tags.md +75 -0
  172. package/docs/modules/Templates.Documents.md +129 -0
  173. package/docs/modules/Templates.Fields.md +77 -0
  174. package/docs/modules/Templates.Pages.md +98 -0
  175. package/docs/modules/Templates.Reminders.md +98 -0
  176. package/docs/modules/Templates.Roles.md +163 -0
  177. package/docs/modules/Templates.Stars.md +52 -0
  178. package/docs/modules/Templates.Tags.md +75 -0
  179. package/docs/modules/Templates.Templates-1.md +139 -0
  180. package/docs/modules/Templates.Types.md +31 -0
  181. package/docs/modules/Templates.md +17 -0
  182. package/docs/modules/Users.Auth.md +196 -0
  183. package/docs/modules/Users.Billing.md +5 -0
  184. package/docs/modules/Users.Notifications.md +25 -0
  185. package/docs/modules/Users.Profiles.md +286 -0
  186. package/docs/modules/Users.Types.md +62 -0
  187. package/docs/modules/Users.md +13 -0
  188. package/docs/modules/Utils.DateTime.md +31 -0
  189. package/docs/modules/Utils.md +9 -0
  190. package/docs/modules/Validators.md +48 -0
  191. package/docs/modules/Whitelabel.md +38 -0
  192. package/docs/modules.md +27 -0
  193. package/docs-html/.nojekyll +1 -0
  194. package/docs-html/assets/highlight.css +85 -0
  195. package/docs-html/assets/icons.css +1043 -0
  196. package/docs-html/assets/icons.png +0 -0
  197. package/docs-html/assets/icons@2x.png +0 -0
  198. package/docs-html/assets/main.js +52 -0
  199. package/docs-html/assets/search.js +1 -0
  200. package/docs-html/assets/style.css +1384 -0
  201. package/docs-html/assets/widgets.png +0 -0
  202. package/docs-html/assets/widgets@2x.png +0 -0
  203. package/docs-html/enums/Templates.Types.SortOptions.html +1 -0
  204. package/docs-html/enums/Templates.Types.Template.html +1 -0
  205. package/docs-html/enums/Templates.Types.TemplatePermissions.html +1 -0
  206. package/docs-html/enums/Templates.Types.TemplateSenderTypes.html +1 -0
  207. package/docs-html/index.html +64 -0
  208. package/docs-html/interfaces/Documents.Documents-1.IActivityEntry.html +1 -0
  209. package/docs-html/interfaces/Documents.Documents-1.IDocument.html +1 -0
  210. package/docs-html/interfaces/Documents.Documents-1.IDocumentSearchOptions.html +1 -0
  211. package/docs-html/interfaces/Documents.Documents-1.IDocumentsSearchResult.html +1 -0
  212. package/docs-html/interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.html +1 -0
  213. package/docs-html/interfaces/Documents.Documents-1.IDocumentsSummary.html +1 -0
  214. package/docs-html/interfaces/Documents.Documents-1.IHistory.html +1 -0
  215. package/docs-html/interfaces/Documents.Documents-1.IRecipient.html +1 -0
  216. package/docs-html/interfaces/Documents.Types.ITemplateSummaryEntry.html +1 -0
  217. package/docs-html/interfaces/Documents.Types.ITemplatesSummary.html +1 -0
  218. package/docs-html/interfaces/Organizations.Types.IApiKey.html +1 -0
  219. package/docs-html/interfaces/Organizations.Types.IApiKeyWithSecret.html +1 -0
  220. package/docs-html/interfaces/Organizations.Types.ICreateApiKeyRequest.html +1 -0
  221. package/docs-html/interfaces/Organizations.Types.IGroup.html +9 -0
  222. package/docs-html/interfaces/Organizations.Types.IGroupDetail.html +9 -0
  223. package/docs-html/interfaces/Organizations.Types.IOrganization.html +9 -0
  224. package/docs-html/interfaces/Organizations.Types.IUpdateApiKeyRequest.html +1 -0
  225. package/docs-html/interfaces/Signatures.ISignature.html +1 -0
  226. package/docs-html/interfaces/Tags.ITags.html +1 -0
  227. package/docs-html/interfaces/Templates.Types.IDocument.html +1 -0
  228. package/docs-html/interfaces/Templates.Types.IField.html +1 -0
  229. package/docs-html/interfaces/Templates.Types.IPage.html +1 -0
  230. package/docs-html/interfaces/Templates.Types.IReminder.html +1 -0
  231. package/docs-html/interfaces/Templates.Types.IRole.html +1 -0
  232. package/docs-html/interfaces/Templates.Types.ISetting.html +1 -0
  233. package/docs-html/interfaces/Templates.Types.IStar.html +1 -0
  234. package/docs-html/interfaces/Templates.Types.ITag.html +1 -0
  235. package/docs-html/interfaces/Templates.Types.ITemplate.html +1 -0
  236. package/docs-html/interfaces/Templates.Types.ITemplateSearchParams.html +1 -0
  237. package/docs-html/interfaces/Templates.Types.ITemplateSummaryEntry.html +1 -0
  238. package/docs-html/interfaces/Templates.Types.ITemplatesSearchResult.html +1 -0
  239. package/docs-html/interfaces/Templates.Types.ITemplatesSummary.html +1 -0
  240. package/docs-html/interfaces/Templates.Types.ITimePeriod.html +1 -0
  241. package/docs-html/interfaces/Users.Types.IActiveSession.html +1 -0
  242. package/docs-html/interfaces/Users.Types.IAuthenticateAppRequest.html +1 -0
  243. package/docs-html/interfaces/Users.Types.IAuthenticateResponse.html +1 -0
  244. package/docs-html/interfaces/Users.Types.IAuthenticateUserRequest.html +1 -0
  245. package/docs-html/interfaces/Users.Types.ICreateProfileRequest.html +1 -0
  246. package/docs-html/interfaces/Users.Types.IPermission.html +5 -0
  247. package/docs-html/interfaces/Users.Types.IProfile.html +21 -0
  248. package/docs-html/interfaces/Users.Types.IRole.html +5 -0
  249. package/docs-html/interfaces/Users.Types.ISwitchProfileResponse.html +1 -0
  250. package/docs-html/interfaces/Users.Types.IUpdateProfileRequest.html +1 -0
  251. package/docs-html/interfaces/Users.Types.TokenValidationRequest.html +1 -0
  252. package/docs-html/interfaces/Users.Types.TokenValidationResponse.html +5 -0
  253. package/docs-html/interfaces/Users.Types.UpdateEmailRequest.html +1 -0
  254. package/docs-html/interfaces/Users.Types.UpdateEmailResponse.html +1 -0
  255. package/docs-html/interfaces/Users.Types.UpdatePasswordRequest.html +1 -0
  256. package/docs-html/interfaces/Users.Types.UpdatePasswordResponse.html +3 -0
  257. package/docs-html/interfaces/Validators.IValidator.html +1 -0
  258. package/docs-html/modules/Documents.Documents-1.html +9 -0
  259. package/docs-html/modules/Documents.Stars.html +1 -0
  260. package/docs-html/modules/Documents.Templates.html +1 -0
  261. package/docs-html/modules/Documents.Types.html +1 -0
  262. package/docs-html/modules/Documents.html +1 -0
  263. package/docs-html/modules/HTTP.Transport.html +22 -0
  264. package/docs-html/modules/HTTP.Types.html +1 -0
  265. package/docs-html/modules/HTTP.html +1 -0
  266. package/docs-html/modules/Organizations.ApiKeys.html +29 -0
  267. package/docs-html/modules/Organizations.Groups.html +15 -0
  268. package/docs-html/modules/Organizations.Invitations.html +1 -0
  269. package/docs-html/modules/Organizations.Members.html +1 -0
  270. package/docs-html/modules/Organizations.Organizations-1.html +1 -0
  271. package/docs-html/modules/Organizations.Types.html +1 -0
  272. package/docs-html/modules/Organizations.Webhooks.html +1 -0
  273. package/docs-html/modules/Organizations.html +6 -0
  274. package/docs-html/modules/Signatures.html +1 -0
  275. package/docs-html/modules/Tags.html +1 -0
  276. package/docs-html/modules/Templates.Documents.html +17 -0
  277. package/docs-html/modules/Templates.Fields.html +1 -0
  278. package/docs-html/modules/Templates.Pages.html +1 -0
  279. package/docs-html/modules/Templates.Reminders.html +1 -0
  280. package/docs-html/modules/Templates.Roles.html +1 -0
  281. package/docs-html/modules/Templates.Stars.html +1 -0
  282. package/docs-html/modules/Templates.Tags.html +1 -0
  283. package/docs-html/modules/Templates.Templates-1.html +5 -0
  284. package/docs-html/modules/Templates.Types.html +1 -0
  285. package/docs-html/modules/Templates.html +1 -0
  286. package/docs-html/modules/Users.Auth.html +31 -0
  287. package/docs-html/modules/Users.Billing.html +1 -0
  288. package/docs-html/modules/Users.Notifications.html +1 -0
  289. package/docs-html/modules/Users.Profiles.html +44 -0
  290. package/docs-html/modules/Users.Types.html +1 -0
  291. package/docs-html/modules/Users.html +1 -0
  292. package/docs-html/modules/Utils.DateTime.html +1 -0
  293. package/docs-html/modules/Utils.html +1 -0
  294. package/docs-html/modules/Validators.html +1 -0
  295. package/docs-html/modules/Whitelabel.html +1 -0
  296. package/docs-html/modules.html +11 -0
  297. package/jestconfig.json +11 -0
  298. package/package-lock.json +3421 -0
  299. package/package.json +4 -2
  300. package/src/Documents/Documents.ts +166 -0
  301. package/src/Documents/Stars.ts +5 -0
  302. package/src/Documents/Templates.ts +17 -0
  303. package/src/Documents/Types.ts +24 -0
  304. package/src/Documents/index.ts +4 -0
  305. package/src/HTTP/Transport.ts +95 -0
  306. package/src/HTTP/Types.ts +1 -0
  307. package/src/HTTP/index.ts +2 -0
  308. package/src/Organizations/ApiKeys.ts +85 -0
  309. package/src/Organizations/Groups.ts +65 -0
  310. package/src/Organizations/Invitations.ts +36 -0
  311. package/src/Organizations/Members.ts +26 -0
  312. package/src/Organizations/Organizations.ts +32 -0
  313. package/src/Organizations/Types.ts +63 -0
  314. package/src/Organizations/Webhooks.ts +11 -0
  315. package/src/Organizations/index.ts +16 -0
  316. package/src/Search/Content.ts +45 -0
  317. package/src/Search/Types.ts +83 -0
  318. package/src/Search/index.ts +2 -0
  319. package/src/Signatures.ts +29 -0
  320. package/src/Tags.ts +22 -0
  321. package/src/Templates/Documents.ts +58 -0
  322. package/src/Templates/Fields.ts +17 -0
  323. package/src/Templates/Pages.ts +22 -0
  324. package/src/Templates/Reminders.ts +22 -0
  325. package/src/Templates/Roles.ts +37 -0
  326. package/src/Templates/Stars.ts +12 -0
  327. package/src/Templates/Tags.ts +17 -0
  328. package/src/Templates/Templates.ts +42 -0
  329. package/src/Templates/Types.ts +201 -0
  330. package/src/Templates/index.ts +9 -0
  331. package/src/Users/Auth.ts +114 -0
  332. package/src/Users/Billing.ts +3 -0
  333. package/src/Users/Notifications.ts +6 -0
  334. package/src/Users/Profiles.ts +153 -0
  335. package/src/Users/Types.ts +156 -0
  336. package/src/Users/index.ts +5 -0
  337. package/src/Utils/DateTime.ts +43 -0
  338. package/src/Utils/index.ts +1 -0
  339. package/src/Validators.ts +16 -0
  340. package/src/Whitelabel.ts +11 -0
  341. package/src/__tests__/Organizations/Apikeys.spec.ts +84 -0
  342. package/src/__tests__/Users/Auth.spec.ts +89 -0
  343. package/src/__tests__/Users/Profiles.spec.ts +162 -0
  344. package/src/index.ts +23 -0
  345. package/tsconfig.json +20 -0
  346. package/tslint.json +3 -0
  347. package/Organizations/Invitations.js +0 -22
  348. package/Organizations/Members.js +0 -16
  349. package/Organizations/Organizations.js +0 -13
  350. package/Organizations/Webhooks.js +0 -7
  351. package/Signatures.js +0 -7
  352. package/Tags.js +0 -4
  353. package/Templates/Fields.js +0 -10
  354. package/Templates/Pages.js +0 -13
  355. package/Templates/Reminders.js +0 -13
  356. package/Templates/Roles.js +0 -22
  357. package/Templates/Stars.js +0 -7
  358. package/Templates/Tags.js +0 -10
  359. package/Validators.js +0 -5
  360. package/Whitelabel.js +0 -3
package/docs-html/modules/Templates.Pages.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>Pages | @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="Templates.html">Templates</a></li><li><a href="Templates.Pages.html">Pages</a></li></ul><h1>Namespace Pages</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="Templates.Pages.html#createPage" class="tsd-kind-icon">create<wbr/>Page</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Pages.html#deletePage" class="tsd-kind-icon">delete<wbr/>Page</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Pages.html#editPage" class="tsd-kind-icon">edit<wbr/>Page</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Pages.html#getPage" class="tsd-kind-icon">get<wbr/>Page</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="createPage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Page</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Page<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Templates.Types.IPage.html" class="tsd-signature-type" data-tsd-kind="Interface">IPage</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/Templates.Types.IPage.html" class="tsd-signature-type" data-tsd-kind="Interface">IPage</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/Templates/Pages.ts#L4">Templates/Pages.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><li><h5>params: <a href="../interfaces/Templates.Types.IPage.html" class="tsd-signature-type" data-tsd-kind="Interface">IPage</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/Templates.Types.IPage.html" class="tsd-signature-type" data-tsd-kind="Interface">IPage</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="deletePage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Page</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Page<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<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/Templates/Pages.ts#L19">Templates/Pages.ts:19</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><li><h5>sequence: <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="editPage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> edit<wbr/>Page</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">edit<wbr/>Page<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<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/Templates/Pages.ts#L9">Templates/Pages.ts:9</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><li><h5>sequence: <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="getPage" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Page</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Page<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<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/Templates/Pages.ts#L14">Templates/Pages.ts:14</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><li><h5>sequence: <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></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class="current tsd-kind-namespace"><a href="Templates.html">Templates</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Documents.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Fields.html">Fields</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Pages.html">Pages</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Reminders.html">Reminders</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Roles.html">Roles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Tags.html">Tags</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Templates-1.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Types.html">Types</a></li></ul></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="Templates.Pages.html#createPage" class="tsd-kind-icon">create<wbr/>Page</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Pages.html#deletePage" class="tsd-kind-icon">delete<wbr/>Page</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Pages.html#editPage" class="tsd-kind-icon">edit<wbr/>Page</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Pages.html#getPage" class="tsd-kind-icon">get<wbr/>Page</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/Templates.Reminders.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>Reminders | @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="Templates.html">Templates</a></li><li><a href="Templates.Reminders.html">Reminders</a></li></ul><h1>Namespace Reminders</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="Templates.Reminders.html#createReminder" class="tsd-kind-icon">create<wbr/>Reminder</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Reminders.html#deleteReminder" class="tsd-kind-icon">delete<wbr/>Reminder</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Reminders.html#editReminder" class="tsd-kind-icon">edit<wbr/>Reminder</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Reminders.html#getReminder" class="tsd-kind-icon">get<wbr/>Reminder</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="createReminder" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Reminder</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Reminder<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/Templates.Types.ITemplate.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplate</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/Templates/Reminders.ts#L4">Templates/Reminders.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><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/Templates.Types.ITemplate.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplate</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="deleteReminder" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Reminder</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Reminder<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, reminderId<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/Templates/Reminders.ts#L19">Templates/Reminders.ts:19</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><li><h5>reminderId: <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="editReminder" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> edit<wbr/>Reminder</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">edit<wbr/>Reminder<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, reminderId<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/Templates.Types.IReminder.html" class="tsd-signature-type" data-tsd-kind="Interface">IReminder</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/Templates/Reminders.ts#L14">Templates/Reminders.ts:14</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><li><h5>reminderId: <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/Templates.Types.IReminder.html" class="tsd-signature-type" data-tsd-kind="Interface">IReminder</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="getReminder" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Reminder</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Reminder<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, reminderId<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/Templates.Types.IReminder.html" class="tsd-signature-type" data-tsd-kind="Interface">IReminder</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/Templates/Reminders.ts#L9">Templates/Reminders.ts:9</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><li><h5>reminderId: <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/Templates.Types.IReminder.html" class="tsd-signature-type" data-tsd-kind="Interface">IReminder</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class="current tsd-kind-namespace"><a href="Templates.html">Templates</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Documents.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Fields.html">Fields</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Pages.html">Pages</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Reminders.html">Reminders</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Roles.html">Roles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Tags.html">Tags</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Templates-1.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Types.html">Types</a></li></ul></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="Templates.Reminders.html#createReminder" class="tsd-kind-icon">create<wbr/>Reminder</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Reminders.html#deleteReminder" class="tsd-kind-icon">delete<wbr/>Reminder</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Reminders.html#editReminder" class="tsd-kind-icon">edit<wbr/>Reminder</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Reminders.html#getReminder" class="tsd-kind-icon">get<wbr/>Reminder</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/Templates.Roles.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>Roles | @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="Templates.html">Templates</a></li><li><a href="Templates.Roles.html">Roles</a></li></ul><h1>Namespace Roles</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="Templates.Roles.html#createRole" class="tsd-kind-icon">create<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#deleteRole" class="tsd-kind-icon">delete<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#deleteSequence" class="tsd-kind-icon">delete<wbr/>Sequence</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#editRole" class="tsd-kind-icon">edit<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#getRole" class="tsd-kind-icon">get<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#getRoleFields" class="tsd-kind-icon">get<wbr/>Role<wbr/>Fields</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#getRoles" class="tsd-kind-icon">get<wbr/>Roles</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="createRole" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Role</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Role<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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/Templates/Roles.ts#L4">Templates/Roles.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><li><h5>params: <a href="../interfaces/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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="deleteRole" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Role</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Role<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roleName<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/Templates/Roles.ts#L24">Templates/Roles.ts:24</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><li><h5>roleName: <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="deleteSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Sequence</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Sequence<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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Roles.ts#L34">Templates/Roles.ts:34</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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="editRole" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> edit<wbr/>Role</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">edit<wbr/>Role<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roleName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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/Templates/Roles.ts#L19">Templates/Roles.ts:19</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><li><h5>roleName: <span class="tsd-signature-type">string</span></h5></li><li><h5>params: <a href="../interfaces/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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="getRole" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Role</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Role<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roleName<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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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/Templates/Roles.ts#L14">Templates/Roles.ts:14</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><li><h5>roleName: <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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</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="getRoleFields" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Role<wbr/>Fields</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Role<wbr/>Fields<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roleName<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/Templates.Types.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</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/Templates/Roles.ts#L29">Templates/Roles.ts:29</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><li><h5>roleName: <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/Templates.Types.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getRoles" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Roles</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Roles<span class="tsd-signature-symbol">(</span>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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Roles.ts#L9">Templates/Roles.ts:9</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/Templates.Types.IRole.html" class="tsd-signature-type" data-tsd-kind="Interface">IRole</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class="current tsd-kind-namespace"><a href="Templates.html">Templates</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Documents.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Fields.html">Fields</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Pages.html">Pages</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Reminders.html">Reminders</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Roles.html">Roles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Tags.html">Tags</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Templates-1.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Types.html">Types</a></li></ul></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="Templates.Roles.html#createRole" class="tsd-kind-icon">create<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#deleteRole" class="tsd-kind-icon">delete<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#deleteSequence" class="tsd-kind-icon">delete<wbr/>Sequence</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#editRole" class="tsd-kind-icon">edit<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#getRole" class="tsd-kind-icon">get<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#getRoleFields" class="tsd-kind-icon">get<wbr/>Role<wbr/>Fields</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Roles.html#getRoles" class="tsd-kind-icon">get<wbr/>Roles</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/Templates.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="Templates.html">Templates</a></li><li><a href="Templates.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="Templates.Stars.html#getStars" class="tsd-kind-icon">get<wbr/>Stars</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.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="getStars" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Stars</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Stars<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/Templates.Types.IStar.html" class="tsd-signature-type" data-tsd-kind="Interface">IStar</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/Templates/Stars.ts#L4">Templates/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/Templates.Types.IStar.html" class="tsd-signature-type" data-tsd-kind="Interface">IStar</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="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/Templates.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/Templates/Stars.ts#L9">Templates/Stars.ts:9</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/Templates.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></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class="current tsd-kind-namespace"><a href="Templates.html">Templates</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Documents.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Fields.html">Fields</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Pages.html">Pages</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Reminders.html">Reminders</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Roles.html">Roles</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Tags.html">Tags</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Templates-1.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Types.html">Types</a></li></ul></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="Templates.Stars.html#getStars" class="tsd-kind-icon">get<wbr/>Stars</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.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/Templates.Tags.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>Tags | @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="Templates.html">Templates</a></li><li><a href="Templates.Tags.html">Tags</a></li></ul><h1>Namespace Tags</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="Templates.Tags.html#createTag" class="tsd-kind-icon">create<wbr/>Tag</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Tags.html#deleteTag" class="tsd-kind-icon">delete<wbr/>Tag</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Tags.html#getTags" class="tsd-kind-icon">get<wbr/>Tags</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="createTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Tag</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Tag<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/Templates.Types.ITag.html" class="tsd-signature-type" data-tsd-kind="Interface">ITag</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/Templates/Tags.ts#L4">Templates/Tags.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><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/Templates.Types.ITag.html" class="tsd-signature-type" data-tsd-kind="Interface">ITag</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="deleteTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Tag</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Tag<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tagName<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/Templates/Tags.ts#L14">Templates/Tags.ts:14</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><li><h5>tagName: <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="getTags" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Tags</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Tags<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/Templates.Types.ITag.html" class="tsd-signature-type" data-tsd-kind="Interface">ITag</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/Templates/Tags.ts#L9">Templates/Tags.ts:9</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/Templates.Types.ITag.html" class="tsd-signature-type" data-tsd-kind="Interface">ITag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class="current tsd-kind-namespace"><a href="Templates.html">Templates</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Documents.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Fields.html">Fields</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Pages.html">Pages</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Reminders.html">Reminders</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Roles.html">Roles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Stars.html">Stars</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Tags.html">Tags</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Templates-1.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Types.html">Types</a></li></ul></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="Templates.Tags.html#createTag" class="tsd-kind-icon">create<wbr/>Tag</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Tags.html#deleteTag" class="tsd-kind-icon">delete<wbr/>Tag</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Tags.html#getTags" class="tsd-kind-icon">get<wbr/>Tags</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/Templates.Templates-1.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>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="Templates.html">Templates</a></li><li><a href="Templates.Templates-1.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="Templates.Templates-1.html#createTemplate" class="tsd-kind-icon">create<wbr/>Template</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#editTemplate" class="tsd-kind-icon">edit<wbr/>Template</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#getSummary" class="tsd-kind-icon">get<wbr/>Summary</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#getTemplate" class="tsd-kind-icon">get<wbr/>Template</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#getTemplates" class="tsd-kind-icon">get<wbr/>Templates</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#searchTemplate" class="tsd-kind-icon">search<wbr/>Template</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="createTemplate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Template</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Template<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/Templates.Types.ITemplate.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplate</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/Templates/Templates.ts#L15">Templates/Templates.ts:15</a></li></ul></aside><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/Templates.Types.ITemplate.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplate</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="editTemplate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> edit<wbr/>Template</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">edit<wbr/>Template<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/Templates.Types.ITemplate.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplate</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/Templates/Templates.ts#L20">Templates/Templates.ts:20</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><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/Templates.Types.ITemplate.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplate</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="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/Templates.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/Templates/Templates.ts#L39">Templates/Templates.ts:39</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/Templates.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="getTemplate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Template</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Template<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><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/Templates/Templates.ts#L10">Templates/Templates.ts:10</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><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="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">[]</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/Templates/Templates.ts#L5">Templates/Templates.ts:5</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">[]</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="searchTemplate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> search<wbr/>Template</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">search<wbr/>Template<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/Templates.Types.ITemplatesSearchResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplatesSearchResult</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/Templates/Templates.ts#L34">Templates/Templates.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Search for templates matching various criteria.</p>
3
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Templates</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/Templates&#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">Templates</span><span class="hl-1">.</span><span class="hl-6">search</span><span class="hl-1">({ ... });</span>
4
+ </code></pre>
5
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <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/Templates.Types.ITemplatesSearchResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ITemplatesSearchResult</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class="current tsd-kind-namespace"><a href="Templates.html">Templates</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Documents.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Fields.html">Fields</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Pages.html">Pages</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Reminders.html">Reminders</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Roles.html">Roles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Tags.html">Tags</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Templates-1.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Types.html">Types</a></li></ul></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="Templates.Templates-1.html#createTemplate" class="tsd-kind-icon">create<wbr/>Template</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#editTemplate" class="tsd-kind-icon">edit<wbr/>Template</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#getSummary" class="tsd-kind-icon">get<wbr/>Summary</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#getTemplate" class="tsd-kind-icon">get<wbr/>Template</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#getTemplates" class="tsd-kind-icon">get<wbr/>Templates</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Templates-1.html#searchTemplate" class="tsd-kind-icon">search<wbr/>Template</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/Templates.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="Templates.html">Templates</a></li><li><a href="Templates.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>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/Templates.Types.SortOptions.html" class="tsd-kind-icon">Sort<wbr/>Options</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/Templates.Types.Template.html" class="tsd-kind-icon">Template</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/Templates.Types.TemplatePermissions.html" class="tsd-kind-icon">Template<wbr/>Permissions</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/Templates.Types.TemplateSenderTypes.html" class="tsd-kind-icon">Template<wbr/>Sender<wbr/>Types</a></li></ul></section><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/Templates.Types.IDocument.html" class="tsd-kind-icon">IDocument</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IField.html" class="tsd-kind-icon">IField</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IPage.html" class="tsd-kind-icon">IPage</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IReminder.html" class="tsd-kind-icon">IReminder</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IRole.html" class="tsd-kind-icon">IRole</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ISetting.html" class="tsd-kind-icon">ISetting</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IStar.html" class="tsd-kind-icon">IStar</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITag.html" class="tsd-kind-icon">ITag</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITemplate.html" class="tsd-kind-icon">ITemplate</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITemplateSearchParams.html" class="tsd-kind-icon">ITemplate<wbr/>Search<wbr/>Params</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.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/Templates.Types.ITemplatesSearchResult.html" class="tsd-kind-icon">ITemplates<wbr/>Search<wbr/>Result</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITemplatesSummary.html" class="tsd-kind-icon">ITemplates<wbr/>Summary</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITimePeriod.html" class="tsd-kind-icon">ITime<wbr/>Period</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class="current tsd-kind-namespace"><a href="Templates.html">Templates</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Documents.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Fields.html">Fields</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Pages.html">Pages</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Reminders.html">Reminders</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Roles.html">Roles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Tags.html">Tags</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Templates-1.html">Templates</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Types.html">Types</a></li></ul></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-enum tsd-parent-kind-namespace"><a href="../enums/Templates.Types.SortOptions.html" class="tsd-kind-icon">Sort<wbr/>Options</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/Templates.Types.Template.html" class="tsd-kind-icon">Template</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/Templates.Types.TemplatePermissions.html" class="tsd-kind-icon">Template<wbr/>Permissions</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/Templates.Types.TemplateSenderTypes.html" class="tsd-kind-icon">Template<wbr/>Sender<wbr/>Types</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IDocument.html" class="tsd-kind-icon">IDocument</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IField.html" class="tsd-kind-icon">IField</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IPage.html" class="tsd-kind-icon">IPage</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IReminder.html" class="tsd-kind-icon">IReminder</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IRole.html" class="tsd-kind-icon">IRole</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ISetting.html" class="tsd-kind-icon">ISetting</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.IStar.html" class="tsd-kind-icon">IStar</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITag.html" class="tsd-kind-icon">ITag</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITemplate.html" class="tsd-kind-icon">ITemplate</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITemplateSearchParams.html" class="tsd-kind-icon">ITemplate<wbr/>Search<wbr/>Params</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.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/Templates.Types.ITemplatesSearchResult.html" class="tsd-kind-icon">ITemplates<wbr/>Search<wbr/>Result</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITemplatesSummary.html" class="tsd-kind-icon">ITemplates<wbr/>Summary</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Templates.Types.ITimePeriod.html" class="tsd-kind-icon">ITime<wbr/>Period</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/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="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>Namespaces</h3><ul class="tsd-index-list"><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Documents.html" class="tsd-kind-icon">Documents</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Fields.html" class="tsd-kind-icon">Fields</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Pages.html" class="tsd-kind-icon">Pages</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Reminders.html" class="tsd-kind-icon">Reminders</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Roles.html" class="tsd-kind-icon">Roles</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Stars.html" class="tsd-kind-icon">Stars</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Tags.html" class="tsd-kind-icon">Tags</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Templates-1.html" class="tsd-kind-icon">Templates</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Types.html" class="tsd-kind-icon">Types</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class="current tsd-kind-namespace"><a href="Templates.html">Templates</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Documents.html">Documents</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Fields.html">Fields</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Pages.html">Pages</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Reminders.html">Reminders</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Roles.html">Roles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Stars.html">Stars</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Tags.html">Tags</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Templates-1.html">Templates</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Templates.Types.html">Types</a></li></ul></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/Users.Auth.html ADDED
@@ -0,0 +1,31 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Auth | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Users.html">Users</a></li><li><a href="Users.Auth.html">Auth</a></li></ul><h1>Namespace Auth</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#authenticateApp" class="tsd-kind-icon">authenticate<wbr/>App</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#authenticateUser" class="tsd-kind-icon">authenticate<wbr/>User</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#refreshTokens" class="tsd-kind-icon">refresh<wbr/>Tokens</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#updateEmail" class="tsd-kind-icon">update<wbr/>Email</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#updatePassword" class="tsd-kind-icon">update<wbr/>Password</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#validateToken" class="tsd-kind-icon">validate<wbr/>Token</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="authenticateApp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> authenticate<wbr/>App</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">authenticate<wbr/>App<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Users.Types.IAuthenticateAppRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateAppRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IAuthenticateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L45">Users/Auth.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Authenticate to Verdocs via client ID / Secret authentication. <strong>NOTE: This is only suitable for
3
+ NodeJS server-side applications. Never expose your Client Secret in a Web or Mobile app!</strong> Also note
4
+ that access tokens may be cached by server-side apps (and this is recommended) but do expire after 2
5
+ hours. This expiration may change based on future security needs. Application developers are encouraged
6
+ to check the <code>exp</code> expiration field in the response accessToken and renew tokens after they expire.</p>
7
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Auth</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/Auth&#39;</span><span class="hl-1">;</span><br/><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-4">const</span><span class="hl-1"> {</span><span class="hl-5">accessToken</span><span class="hl-1">} = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Auth</span><span class="hl-1">.</span><span class="hl-6">authenticateApp</span><span class="hl-1">({ </span><span class="hl-0">client_id:</span><span class="hl-1"> </span><span class="hl-3">&#39;CLIENTID&#39;</span><span class="hl-1">, </span><span class="hl-0">client_secret:</span><span class="hl-1"> </span><span class="hl-3">&#39;SECRET&#39;</span><span class="hl-1"> });</span><br/><span class="hl-0">Transport</span><span class="hl-1">.</span><span class="hl-6">setAuthToken</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>params: <a href="../interfaces/Users.Types.IAuthenticateAppRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateAppRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IAuthenticateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateResponse</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="authenticateUser" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> authenticate<wbr/>User</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">authenticate<wbr/>User<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Users.Types.IAuthenticateUserRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateUserRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IAuthenticateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L25">Users/Auth.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>Authenticate to Verdocs via user/password authentication</p>
11
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Auth</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/Auth&#39;</span><span class="hl-1">;</span><br/><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-4">const</span><span class="hl-1"> {</span><span class="hl-5">accessToken</span><span class="hl-1">} = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Auth</span><span class="hl-1">.</span><span class="hl-6">authenticateUser</span><span class="hl-1">({ </span><span class="hl-0">username:</span><span class="hl-1"> </span><span class="hl-3">&#39;test@test.com&#39;</span><span class="hl-1">, </span><span class="hl-0">password:</span><span class="hl-1"> </span><span class="hl-3">&#39;PASSWORD&#39;</span><span class="hl-1"> });</span><br/><span class="hl-0">Transport</span><span class="hl-1">.</span><span class="hl-6">setAuthToken</span><span class="hl-1">(</span><span class="hl-0">accessToken</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>params: <a href="../interfaces/Users.Types.IAuthenticateUserRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateUserRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IAuthenticateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateResponse</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="refreshTokens" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> refresh<wbr/>Tokens</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">refresh<wbr/>Tokens<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IAuthenticateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L80">Users/Auth.ts:80</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>If called before the session expires, this will refresh the caller&#39;s session and tokens.</p>
15
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Auth</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/Auth&#39;</span><span class="hl-1">;</span><br/><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-4">const</span><span class="hl-1"> {</span><span class="hl-5">accessToken</span><span class="hl-1">} = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Auth</span><span class="hl-1">.</span><span class="hl-6">refreshTokens</span><span class="hl-1">();</span><br/><span class="hl-0">Transport</span><span class="hl-1">.</span><span class="hl-6">setAuthToken</span><span class="hl-1">(</span><span class="hl-0">accessToken</span><span class="hl-1">);</span>
16
+ </code></pre>
17
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.IAuthenticateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthenticateResponse</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="updateEmail" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> update<wbr/>Email</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">update<wbr/>Email<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Users.Types.UpdateEmailRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateEmailRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.UpdateEmailResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateEmailResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L111">Users/Auth.ts:111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
18
+ <p>Update the caller&#39;s email address.</p>
19
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Auth</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/Auth&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> {</span><span class="hl-5">profiles</span><span class="hl-1">} = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Auth</span><span class="hl-1">.</span><span class="hl-6">updateEmail</span><span class="hl-1">({ </span><span class="hl-0">email:</span><span class="hl-1"> </span><span class="hl-0">newEmail</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>params: <a href="../interfaces/Users.Types.UpdateEmailRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateEmailRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.UpdateEmailResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateEmailResponse</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="updatePassword" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> update<wbr/>Password</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">update<wbr/>Password<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Users.Types.UpdatePasswordRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdatePasswordRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.UpdatePasswordResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdatePasswordResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L97">Users/Auth.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
22
+ <p>Update the caller&#39;s password. To help prevent CSRF attack vectors, the user&#39;s old password and email address are required.</p>
23
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Auth</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/Auth&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> {</span><span class="hl-5">status</span><span class="hl-1">, </span><span class="hl-5">message</span><span class="hl-1">} = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Auth</span><span class="hl-1">.</span><span class="hl-6">updatePassword</span><span class="hl-1">({ </span><span class="hl-0">email</span><span class="hl-1">, </span><span class="hl-0">oldPassword</span><span class="hl-1">, </span><span class="hl-0">newPassword</span><span class="hl-1"> });</span><br/><span class="hl-2">if</span><span class="hl-1"> (</span><span class="hl-0">status</span><span class="hl-1"> !== </span><span class="hl-3">&#39;OK&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">window</span><span class="hl-1">.</span><span class="hl-6">alert</span><span class="hl-1">(</span><span class="hl-3">`Password reset error: </span><span class="hl-4">${</span><span class="hl-0">message</span><span class="hl-4">}</span><span class="hl-3">`</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
24
+ </code></pre>
25
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../interfaces/Users.Types.UpdatePasswordRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdatePasswordRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.UpdatePasswordResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdatePasswordResponse</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="validateToken" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> validate<wbr/>Token</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">validate<wbr/>Token<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Users.Types.TokenValidationRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TokenValidationRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.TokenValidationResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TokenValidationResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L64">Users/Auth.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
26
+ <p>Validate a token. Only Verdocs tokens will be accepted. Most applications can decode tokens locally,
27
+ because tokens will be validated when API calls are made anyway. However, high-security applications
28
+ may use this endpoint to check if a token has been revoked.</p>
29
+ </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Auth</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/Auth&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> {</span><span class="hl-5">valid</span><span class="hl-1">} = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Auth</span><span class="hl-1">.</span><span class="hl-6">validateToken</span><span class="hl-1">({ </span><span class="hl-0">token</span><span class="hl-1"> });</span><br/><span class="hl-2">if</span><span class="hl-1"> (!</span><span class="hl-0">valid</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">window</span><span class="hl-1">.</span><span class="hl-6">alert</span><span class="hl-1">(</span><span class="hl-3">&#39;Session invalid or expired. Please re-authenticate.&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
30
+ </code></pre>
31
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../interfaces/Users.Types.TokenValidationRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TokenValidationRequest</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Users.Types.TokenValidationResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TokenValidationResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class="current tsd-kind-namespace"><a href="Users.html">Users</a><ul><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Profiles.html">Profiles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Types.html">Types</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#authenticateApp" class="tsd-kind-icon">authenticate<wbr/>App</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#authenticateUser" class="tsd-kind-icon">authenticate<wbr/>User</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#refreshTokens" class="tsd-kind-icon">refresh<wbr/>Tokens</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#updateEmail" class="tsd-kind-icon">update<wbr/>Email</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#updatePassword" class="tsd-kind-icon">update<wbr/>Password</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Auth.html#validateToken" class="tsd-kind-icon">validate<wbr/>Token</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs-html/modules/Users.Billing.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>Billing | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Users.html">Users</a></li><li><a href="Users.Billing.html">Billing</a></li></ul><h1>Namespace Billing</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class="current tsd-kind-namespace"><a href="Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Auth.html">Auth</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Billing.html">Billing</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Profiles.html">Profiles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Types.html">Types</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs-html/modules/Users.Notifications.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>Notifications | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Users.html">Users</a></li><li><a href="Users.Notifications.html">Notifications</a></li></ul><h1>Namespace Notifications</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Notifications.html#getNotifications" class="tsd-kind-icon">get<wbr/>Notifications</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="getNotifications" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Notifications</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Notifications<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/Users/Notifications.ts#L3">Users/Notifications.ts:3</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class=" tsd-kind-namespace"><a href="Organizations.html">Organizations</a></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class="current tsd-kind-namespace"><a href="Users.html">Users</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Auth.html">Auth</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Billing.html">Billing</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Notifications.html">Notifications</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Profiles.html">Profiles</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Users.Types.html">Types</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Users.Notifications.html#getNotifications" class="tsd-kind-icon">get<wbr/>Notifications</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>