@verdocs/js-sdk 1.0.8 → 1.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitignore +4 -0
- package/.idea/.gitignore +8 -0
- package/.idea/inspectionProfiles/Project_Default.xml +12 -0
- package/.idea/js-sdk.iml +11 -0
- package/.idea/misc.xml +6 -0
- package/.idea/modules.xml +8 -0
- package/.idea/vcs.xml +6 -0
- package/.prettierrc.js +11 -0
- package/LICENSE +21 -0
- package/README.md +8 -5
- package/__mocks__/axios.ts +3 -0
- package/dist/.npmignore +5 -0
- package/{Documents → dist/Documents}/Documents.d.ts +9 -0
- package/{Documents → dist/Documents}/Documents.js +24 -7
- package/{Documents → dist/Documents}/Stars.d.ts +0 -0
- package/{Documents → dist/Documents}/Stars.js +2 -2
- package/{Documents → dist/Documents}/Templates.d.ts +0 -0
- package/{Documents → dist/Documents}/Templates.js +22 -10
- package/{Documents → dist/Documents}/Types.d.ts +0 -0
- package/{Api → dist/Documents}/Types.js +0 -0
- package/{Documents → dist/Documents}/index.d.ts +0 -0
- package/{Documents → dist/Documents}/index.js +0 -0
- package/dist/HTTP/Transport.d.ts +51 -0
- package/dist/HTTP/Transport.js +88 -0
- package/{HTTP → dist/HTTP}/Types.d.ts +0 -0
- package/{Documents → dist/HTTP}/Types.js +0 -0
- package/{HTTP → dist/HTTP}/index.d.ts +0 -0
- package/{HTTP → dist/HTTP}/index.js +0 -0
- package/{Organizations → dist/Organizations}/ApiKeys.d.ts +0 -0
- package/{Organizations → dist/Organizations}/ApiKeys.js +16 -6
- package/{Organizations → dist/Organizations}/Groups.d.ts +0 -0
- package/{Organizations → dist/Organizations}/Groups.js +22 -8
- package/{Organizations → dist/Organizations}/Invitations.d.ts +0 -0
- package/dist/Organizations/Invitations.js +36 -0
- package/{Organizations → dist/Organizations}/Members.d.ts +0 -0
- package/dist/Organizations/Members.js +26 -0
- package/{Organizations → dist/Organizations}/Organizations.d.ts +0 -0
- package/dist/Organizations/Organizations.js +31 -0
- package/{Organizations → dist/Organizations}/Types.d.ts +0 -0
- package/{HTTP → dist/Organizations}/Types.js +0 -0
- package/{Organizations → dist/Organizations}/Webhooks.d.ts +0 -0
- package/dist/Organizations/Webhooks.js +11 -0
- package/{Organizations → dist/Organizations}/index.d.ts +0 -0
- package/{Organizations → dist/Organizations}/index.js +0 -0
- package/dist/README.md +68 -0
- package/{Search → dist/Search}/Content.d.ts +0 -0
- package/{Search → dist/Search}/Content.js +22 -10
- package/{Search → dist/Search}/Types.d.ts +0 -0
- package/{Organizations → dist/Search}/Types.js +0 -0
- package/{Search → dist/Search}/index.d.ts +0 -0
- package/{Search → dist/Search}/index.js +0 -0
- package/{Signatures.d.ts → dist/Signatures.d.ts} +0 -0
- package/dist/Signatures.js +21 -0
- package/{Tags.d.ts → dist/Tags.d.ts} +0 -0
- package/dist/Tags.js +16 -0
- package/{Templates → dist/Templates}/Documents.d.ts +0 -0
- package/{Templates → dist/Templates}/Documents.js +13 -5
- package/{Templates → dist/Templates}/Fields.d.ts +0 -0
- package/dist/Templates/Fields.js +16 -0
- package/{Templates → dist/Templates}/Pages.d.ts +0 -0
- package/dist/Templates/Pages.js +21 -0
- package/{Templates → dist/Templates}/Reminders.d.ts +0 -0
- package/dist/Templates/Reminders.js +21 -0
- package/{Templates → dist/Templates}/Roles.d.ts +0 -0
- package/dist/Templates/Roles.js +36 -0
- package/{Templates → dist/Templates}/Stars.d.ts +0 -0
- package/dist/Templates/Stars.js +11 -0
- package/{Templates → dist/Templates}/Tags.d.ts +0 -0
- package/dist/Templates/Tags.js +16 -0
- package/{Templates → dist/Templates}/Templates.d.ts +0 -0
- package/{Templates → dist/Templates}/Templates.js +33 -11
- package/{Templates → dist/Templates}/Types.d.ts +0 -0
- package/{Templates → dist/Templates}/Types.js +0 -0
- package/{Templates → dist/Templates}/index.d.ts +0 -0
- package/{Templates → dist/Templates}/index.js +0 -0
- package/{Users → dist/Users}/Auth.d.ts +6 -6
- package/{Users → dist/Users}/Auth.js +27 -13
- package/{Users → dist/Users}/Billing.d.ts +0 -0
- package/{Users → dist/Users}/Billing.js +0 -0
- package/{Api → dist/Users}/Notifications.d.ts +0 -0
- package/{Api → dist/Users}/Notifications.js +8 -4
- package/{Users → dist/Users}/Profiles.d.ts +0 -0
- package/{Users → dist/Users}/Profiles.js +41 -11
- package/{Users → dist/Users}/Types.d.ts +13 -0
- package/{Search → dist/Users}/Types.js +0 -0
- package/{Users → dist/Users}/index.d.ts +0 -0
- package/{Users → dist/Users}/index.js +0 -0
- package/{Utils → dist/Utils}/DateTime.d.ts +0 -0
- package/{Utils → dist/Utils}/DateTime.js +0 -0
- package/{Utils → dist/Utils}/index.d.ts +0 -0
- package/{Utils → dist/Utils}/index.js +0 -0
- package/{Validators.d.ts → dist/Validators.d.ts} +0 -0
- package/dist/Validators.js +11 -0
- package/{Whitelabel.d.ts → dist/Whitelabel.d.ts} +0 -0
- package/dist/Whitelabel.js +11 -0
- package/{index.d.ts → dist/index.d.ts} +0 -0
- package/{index.js → dist/index.js} +0 -0
- package/dist/package.json +64 -0
- package/docs/.nojekyll +1 -0
- package/docs/README.md +70 -0
- package/docs/enums/Templates.Types.SortOptions.md +76 -0
- package/docs/enums/Templates.Types.Template.md +153 -0
- package/docs/enums/Templates.Types.TemplatePermissions.md +109 -0
- package/docs/enums/Templates.Types.TemplateSenderTypes.md +65 -0
- package/docs/interfaces/Documents.Documents-1.IActivityEntry.md +120 -0
- package/docs/interfaces/Documents.Documents-1.IDocument.md +175 -0
- package/docs/interfaces/Documents.Documents-1.IDocumentSearchOptions.md +98 -0
- package/docs/interfaces/Documents.Documents-1.IDocumentsSearchResult.md +43 -0
- package/docs/interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.md +131 -0
- package/docs/interfaces/Documents.Documents-1.IDocumentsSummary.md +67 -0
- package/docs/interfaces/Documents.Documents-1.IHistory.md +76 -0
- package/docs/interfaces/Documents.Documents-1.IRecipient.md +208 -0
- package/docs/interfaces/Documents.Types.ITemplateSummaryEntry.md +186 -0
- package/docs/interfaces/Documents.Types.ITemplatesSummary.md +43 -0
- package/docs/interfaces/Organizations.Types.IApiKey.md +60 -0
- package/docs/interfaces/Organizations.Types.IApiKeyWithSecret.md +87 -0
- package/docs/interfaces/Organizations.Types.ICreateApiKeyRequest.md +32 -0
- package/docs/interfaces/Organizations.Types.IGroup.md +101 -0
- package/docs/interfaces/Organizations.Types.IGroupDetail.md +129 -0
- package/docs/interfaces/Organizations.Types.IOrganization.md +128 -0
- package/docs/interfaces/Organizations.Types.IUpdateApiKeyRequest.md +32 -0
- package/docs/interfaces/Signatures.ISignature.md +65 -0
- package/docs/interfaces/Tags.ITags.md +43 -0
- package/docs/interfaces/Templates.Types.IDocument.md +109 -0
- package/docs/interfaces/Templates.Types.IField.md +109 -0
- package/docs/interfaces/Templates.Types.IPage.md +87 -0
- package/docs/interfaces/Templates.Types.IReminder.md +109 -0
- package/docs/interfaces/Templates.Types.IRole.md +120 -0
- package/docs/interfaces/Templates.Types.ISetting.md +98 -0
- package/docs/interfaces/Templates.Types.IStar.md +32 -0
- package/docs/interfaces/Templates.Types.ITag.md +32 -0
- package/docs/interfaces/Templates.Types.ITemplate.md +219 -0
- package/docs/interfaces/Templates.Types.ITemplateSearchParams.md +197 -0
- package/docs/interfaces/Templates.Types.ITemplateSummaryEntry.md +186 -0
- package/docs/interfaces/Templates.Types.ITemplatesSearchResult.md +43 -0
- package/docs/interfaces/Templates.Types.ITemplatesSummary.md +43 -0
- package/docs/interfaces/Templates.Types.ITimePeriod.md +32 -0
- package/docs/interfaces/Users.Types.IActiveSession.md +131 -0
- package/docs/interfaces/Users.Types.IAuthenticateAppRequest.md +32 -0
- package/docs/interfaces/Users.Types.IAuthenticateResponse.md +43 -0
- package/docs/interfaces/Users.Types.IAuthenticateUserRequest.md +32 -0
- package/docs/interfaces/Users.Types.ICreateProfileRequest.md +54 -0
- package/docs/interfaces/Users.Types.IPermission.md +36 -0
- package/docs/interfaces/Users.Types.IProfile.md +173 -0
- package/docs/interfaces/Users.Types.IRole.md +36 -0
- package/docs/interfaces/Users.Types.ISwitchProfileResponse.md +54 -0
- package/docs/interfaces/Users.Types.IUpdateProfileRequest.md +43 -0
- package/docs/interfaces/Users.Types.TokenValidationRequest.md +21 -0
- package/docs/interfaces/Users.Types.TokenValidationResponse.md +36 -0
- package/docs/interfaces/Users.Types.UpdateEmailRequest.md +21 -0
- package/docs/interfaces/Users.Types.UpdateEmailResponse.md +21 -0
- package/docs/interfaces/Users.Types.UpdatePasswordRequest.md +43 -0
- package/docs/interfaces/Users.Types.UpdatePasswordResponse.md +34 -0
- package/docs/interfaces/Validators.IValidator.md +32 -0
- package/docs/modules/Documents.Documents-1.md +137 -0
- package/docs/modules/Documents.Stars.md +31 -0
- package/docs/modules/Documents.Templates.md +61 -0
- package/docs/modules/Documents.Types.md +12 -0
- package/docs/modules/Documents.md +12 -0
- package/docs/modules/HTTP.Transport.md +150 -0
- package/docs/modules/HTTP.Types.md +21 -0
- package/docs/modules/HTTP.md +10 -0
- package/docs/modules/Organizations.ApiKeys.md +169 -0
- package/docs/modules/Organizations.Groups.md +190 -0
- package/docs/modules/Organizations.Invitations.md +166 -0
- package/docs/modules/Organizations.Members.md +121 -0
- package/docs/modules/Organizations.Organizations-1.md +119 -0
- package/docs/modules/Organizations.Types.md +17 -0
- package/docs/modules/Organizations.Webhooks.md +53 -0
- package/docs/modules/Organizations.md +20 -0
- package/docs/modules/Signatures.md +90 -0
- package/docs/modules/Tags.md +75 -0
- package/docs/modules/Templates.Documents.md +129 -0
- package/docs/modules/Templates.Fields.md +77 -0
- package/docs/modules/Templates.Pages.md +98 -0
- package/docs/modules/Templates.Reminders.md +98 -0
- package/docs/modules/Templates.Roles.md +163 -0
- package/docs/modules/Templates.Stars.md +52 -0
- package/docs/modules/Templates.Tags.md +75 -0
- package/docs/modules/Templates.Templates-1.md +139 -0
- package/docs/modules/Templates.Types.md +31 -0
- package/docs/modules/Templates.md +17 -0
- package/docs/modules/Users.Auth.md +196 -0
- package/docs/modules/Users.Billing.md +5 -0
- package/docs/modules/Users.Notifications.md +25 -0
- package/docs/modules/Users.Profiles.md +286 -0
- package/docs/modules/Users.Types.md +62 -0
- package/docs/modules/Users.md +13 -0
- package/docs/modules/Utils.DateTime.md +31 -0
- package/docs/modules/Utils.md +9 -0
- package/docs/modules/Validators.md +48 -0
- package/docs/modules/Whitelabel.md +38 -0
- package/docs/modules.md +27 -0
- package/docs-html/.nojekyll +1 -0
- package/docs-html/assets/highlight.css +85 -0
- package/docs-html/assets/icons.css +1043 -0
- package/docs-html/assets/icons.png +0 -0
- package/docs-html/assets/icons@2x.png +0 -0
- package/docs-html/assets/main.js +52 -0
- package/docs-html/assets/search.js +1 -0
- package/docs-html/assets/style.css +1384 -0
- package/docs-html/assets/widgets.png +0 -0
- package/docs-html/assets/widgets@2x.png +0 -0
- package/docs-html/enums/Templates.Types.SortOptions.html +1 -0
- package/docs-html/enums/Templates.Types.Template.html +1 -0
- package/docs-html/enums/Templates.Types.TemplatePermissions.html +1 -0
- package/docs-html/enums/Templates.Types.TemplateSenderTypes.html +1 -0
- package/docs-html/index.html +64 -0
- package/docs-html/interfaces/Documents.Documents-1.IActivityEntry.html +1 -0
- package/docs-html/interfaces/Documents.Documents-1.IDocument.html +1 -0
- package/docs-html/interfaces/Documents.Documents-1.IDocumentSearchOptions.html +1 -0
- package/docs-html/interfaces/Documents.Documents-1.IDocumentsSearchResult.html +1 -0
- package/docs-html/interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.html +1 -0
- package/docs-html/interfaces/Documents.Documents-1.IDocumentsSummary.html +1 -0
- package/docs-html/interfaces/Documents.Documents-1.IHistory.html +1 -0
- package/docs-html/interfaces/Documents.Documents-1.IRecipient.html +1 -0
- package/docs-html/interfaces/Documents.Types.ITemplateSummaryEntry.html +1 -0
- package/docs-html/interfaces/Documents.Types.ITemplatesSummary.html +1 -0
- package/docs-html/interfaces/Organizations.Types.IApiKey.html +1 -0
- package/docs-html/interfaces/Organizations.Types.IApiKeyWithSecret.html +1 -0
- package/docs-html/interfaces/Organizations.Types.ICreateApiKeyRequest.html +1 -0
- package/docs-html/interfaces/Organizations.Types.IGroup.html +9 -0
- package/docs-html/interfaces/Organizations.Types.IGroupDetail.html +9 -0
- package/docs-html/interfaces/Organizations.Types.IOrganization.html +9 -0
- package/docs-html/interfaces/Organizations.Types.IUpdateApiKeyRequest.html +1 -0
- package/docs-html/interfaces/Signatures.ISignature.html +1 -0
- package/docs-html/interfaces/Tags.ITags.html +1 -0
- package/docs-html/interfaces/Templates.Types.IDocument.html +1 -0
- package/docs-html/interfaces/Templates.Types.IField.html +1 -0
- package/docs-html/interfaces/Templates.Types.IPage.html +1 -0
- package/docs-html/interfaces/Templates.Types.IReminder.html +1 -0
- package/docs-html/interfaces/Templates.Types.IRole.html +1 -0
- package/docs-html/interfaces/Templates.Types.ISetting.html +1 -0
- package/docs-html/interfaces/Templates.Types.IStar.html +1 -0
- package/docs-html/interfaces/Templates.Types.ITag.html +1 -0
- package/docs-html/interfaces/Templates.Types.ITemplate.html +1 -0
- package/docs-html/interfaces/Templates.Types.ITemplateSearchParams.html +1 -0
- package/docs-html/interfaces/Templates.Types.ITemplateSummaryEntry.html +1 -0
- package/docs-html/interfaces/Templates.Types.ITemplatesSearchResult.html +1 -0
- package/docs-html/interfaces/Templates.Types.ITemplatesSummary.html +1 -0
- package/docs-html/interfaces/Templates.Types.ITimePeriod.html +1 -0
- package/docs-html/interfaces/Users.Types.IActiveSession.html +1 -0
- package/docs-html/interfaces/Users.Types.IAuthenticateAppRequest.html +1 -0
- package/docs-html/interfaces/Users.Types.IAuthenticateResponse.html +1 -0
- package/docs-html/interfaces/Users.Types.IAuthenticateUserRequest.html +1 -0
- package/docs-html/interfaces/Users.Types.ICreateProfileRequest.html +1 -0
- package/docs-html/interfaces/Users.Types.IPermission.html +5 -0
- package/docs-html/interfaces/Users.Types.IProfile.html +21 -0
- package/docs-html/interfaces/Users.Types.IRole.html +5 -0
- package/docs-html/interfaces/Users.Types.ISwitchProfileResponse.html +1 -0
- package/docs-html/interfaces/Users.Types.IUpdateProfileRequest.html +1 -0
- package/docs-html/interfaces/Users.Types.TokenValidationRequest.html +1 -0
- package/docs-html/interfaces/Users.Types.TokenValidationResponse.html +5 -0
- package/docs-html/interfaces/Users.Types.UpdateEmailRequest.html +1 -0
- package/docs-html/interfaces/Users.Types.UpdateEmailResponse.html +1 -0
- package/docs-html/interfaces/Users.Types.UpdatePasswordRequest.html +1 -0
- package/docs-html/interfaces/Users.Types.UpdatePasswordResponse.html +3 -0
- package/docs-html/interfaces/Validators.IValidator.html +1 -0
- package/docs-html/modules/Documents.Documents-1.html +9 -0
- package/docs-html/modules/Documents.Stars.html +1 -0
- package/docs-html/modules/Documents.Templates.html +1 -0
- package/docs-html/modules/Documents.Types.html +1 -0
- package/docs-html/modules/Documents.html +1 -0
- package/docs-html/modules/HTTP.Transport.html +22 -0
- package/docs-html/modules/HTTP.Types.html +1 -0
- package/docs-html/modules/HTTP.html +1 -0
- package/docs-html/modules/Organizations.ApiKeys.html +29 -0
- package/docs-html/modules/Organizations.Groups.html +15 -0
- package/docs-html/modules/Organizations.Invitations.html +1 -0
- package/docs-html/modules/Organizations.Members.html +1 -0
- package/docs-html/modules/Organizations.Organizations-1.html +1 -0
- package/docs-html/modules/Organizations.Types.html +1 -0
- package/docs-html/modules/Organizations.Webhooks.html +1 -0
- package/docs-html/modules/Organizations.html +6 -0
- package/docs-html/modules/Signatures.html +1 -0
- package/docs-html/modules/Tags.html +1 -0
- package/docs-html/modules/Templates.Documents.html +17 -0
- package/docs-html/modules/Templates.Fields.html +1 -0
- package/docs-html/modules/Templates.Pages.html +1 -0
- package/docs-html/modules/Templates.Reminders.html +1 -0
- package/docs-html/modules/Templates.Roles.html +1 -0
- package/docs-html/modules/Templates.Stars.html +1 -0
- package/docs-html/modules/Templates.Tags.html +1 -0
- package/docs-html/modules/Templates.Templates-1.html +5 -0
- package/docs-html/modules/Templates.Types.html +1 -0
- package/docs-html/modules/Templates.html +1 -0
- package/docs-html/modules/Users.Auth.html +31 -0
- package/docs-html/modules/Users.Billing.html +1 -0
- package/docs-html/modules/Users.Notifications.html +1 -0
- package/docs-html/modules/Users.Profiles.html +44 -0
- package/docs-html/modules/Users.Types.html +1 -0
- package/docs-html/modules/Users.html +1 -0
- package/docs-html/modules/Utils.DateTime.html +1 -0
- package/docs-html/modules/Utils.html +1 -0
- package/docs-html/modules/Validators.html +1 -0
- package/docs-html/modules/Whitelabel.html +1 -0
- package/docs-html/modules.html +11 -0
- package/jestconfig.json +11 -0
- package/package-lock.json +3421 -0
- package/package.json +6 -3
- package/src/Documents/Documents.ts +166 -0
- package/src/Documents/Stars.ts +5 -0
- package/src/Documents/Templates.ts +17 -0
- package/src/Documents/Types.ts +24 -0
- package/src/Documents/index.ts +4 -0
- package/src/HTTP/Transport.ts +95 -0
- package/src/HTTP/Types.ts +1 -0
- package/src/HTTP/index.ts +2 -0
- package/src/Organizations/ApiKeys.ts +85 -0
- package/src/Organizations/Groups.ts +65 -0
- package/src/Organizations/Invitations.ts +36 -0
- package/src/Organizations/Members.ts +26 -0
- package/src/Organizations/Organizations.ts +32 -0
- package/src/Organizations/Types.ts +63 -0
- package/src/Organizations/Webhooks.ts +11 -0
- package/src/Organizations/index.ts +16 -0
- package/src/Search/Content.ts +45 -0
- package/src/Search/Types.ts +83 -0
- package/src/Search/index.ts +2 -0
- package/src/Signatures.ts +29 -0
- package/src/Tags.ts +22 -0
- package/src/Templates/Documents.ts +58 -0
- package/src/Templates/Fields.ts +17 -0
- package/src/Templates/Pages.ts +22 -0
- package/src/Templates/Reminders.ts +22 -0
- package/src/Templates/Roles.ts +37 -0
- package/src/Templates/Stars.ts +12 -0
- package/src/Templates/Tags.ts +17 -0
- package/src/Templates/Templates.ts +42 -0
- package/src/Templates/Types.ts +201 -0
- package/src/Templates/index.ts +9 -0
- package/src/Users/Auth.ts +114 -0
- package/src/Users/Billing.ts +3 -0
- package/src/Users/Notifications.ts +6 -0
- package/src/Users/Profiles.ts +153 -0
- package/src/Users/Types.ts +156 -0
- package/src/Users/index.ts +5 -0
- package/src/Utils/DateTime.ts +43 -0
- package/src/Utils/index.ts +1 -0
- package/src/Validators.ts +16 -0
- package/src/Whitelabel.ts +11 -0
- package/src/__tests__/Organizations/Apikeys.spec.ts +84 -0
- package/src/__tests__/Users/Auth.spec.ts +89 -0
- package/src/__tests__/Users/Profiles.spec.ts +162 -0
- package/src/index.ts +23 -0
- package/tsconfig.json +20 -0
- package/tslint.json +3 -0
- package/Api/Auth.d.ts +0 -71
- package/Api/Auth.js +0 -24
- package/Api/Documents.d.ts +0 -124
- package/Api/Documents.js +0 -47
- package/Api/Endpoint.d.ts +0 -2
- package/Api/Endpoint.js +0 -9
- package/Api/Templates.d.ts +0 -33
- package/Api/Templates.js +0 -55
- package/Api/Types.d.ts +0 -182
- package/Api/index.d.ts +0 -2
- package/Api/index.js +0 -2
- package/AuthManager.d.ts +0 -14
- package/AuthManager.js +0 -53
- package/HTTP/Endpoint.d.ts +0 -4
- package/HTTP/Endpoint.js +0 -12
- package/HTTP/Transport.d.ts +0 -3
- package/HTTP/Transport.js +0 -12
- package/Organizations/Invitations.js +0 -22
- package/Organizations/Members.js +0 -16
- package/Organizations/Organizations.js +0 -13
- package/Organizations/Webhooks.js +0 -7
- package/Signatures.js +0 -7
- package/Tags.js +0 -4
- package/Templates/Fields.js +0 -10
- package/Templates/Pages.js +0 -13
- package/Templates/Reminders.js +0 -13
- package/Templates/Roles.js +0 -22
- package/Templates/Stars.js +0 -7
- package/Templates/Tags.js +0 -10
- package/Users/Notifications.d.ts +0 -1
- package/Users/Notifications.js +0 -40
- package/Users/Types.js +0 -1
- package/Validators.js +0 -5
- package/Whitelabel.js +0 -3
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Groups | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Organizations.html">Organizations</a></li><li><a href="Organizations.Groups.html">Groups</a></li></ul><h1>Namespace Groups</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
+
<p>Organizations may contain "Groups" of user profiles, called Members. Groups may have permissions assigned that
|
|
3
|
+
apply to all Members, making it easy to configure role-based access control (RBAC) within an Organization. Note
|
|
4
|
+
that permissions are <strong>additive</strong>. A user may be a member of more than one group, and may also have permissions
|
|
5
|
+
assigned directly. In that case, the user will have the combined set of all permissions inherited from all
|
|
6
|
+
sources.</p>
|
|
7
|
+
</div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#addMembers" class="tsd-kind-icon">add<wbr/>Members</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#addPermission" class="tsd-kind-icon">add<wbr/>Permission</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#deleteMembers" class="tsd-kind-icon">delete<wbr/>Members</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#deletePermission" class="tsd-kind-icon">delete<wbr/>Permission</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#getGroup" class="tsd-kind-icon">get<wbr/>Group</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#getGroups" class="tsd-kind-icon">get<wbr/>Groups</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#getMembers" class="tsd-kind-icon">get<wbr/>Members</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="addMembers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr/>Members</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">add<wbr/>Members<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, groupId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L47">Organizations/Groups.ts:47</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>groupId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="addPermission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr/>Permission</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">add<wbr/>Permission<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, groupId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, permissionId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L57">Organizations/Groups.ts:57</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>groupId: <span class="tsd-signature-type">string</span></h5></li><li><h5>permissionId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deleteMembers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Members</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Members<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, groupId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L52">Organizations/Groups.ts:52</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>groupId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deletePermission" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Permission</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Permission<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, groupId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, permissionId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L62">Organizations/Groups.ts:62</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>groupId: <span class="tsd-signature-type">string</span></h5></li><li><h5>permissionId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getGroup" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Group</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Group<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, groupId<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"><</span><a href="../interfaces/Organizations.Types.IGroupDetail.html" class="tsd-signature-type" data-tsd-kind="Interface">IGroupDetail</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L37">Organizations/Groups.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
|
+
<p>Get the details for a group.</p>
|
|
9
|
+
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Groups</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@verdocs/js-sdk/Organizations'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">groups</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Groups</span><span class="hl-1">.</span><span class="hl-6">getGroups</span><span class="hl-1">(</span><span class="hl-5">ORGID</span><span class="hl-1">);</span>
|
|
10
|
+
</code></pre>
|
|
11
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>groupId: <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"><</span><a href="../interfaces/Organizations.Types.IGroupDetail.html" class="tsd-signature-type" data-tsd-kind="Interface">IGroupDetail</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getGroups" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Groups</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Groups<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Organizations.Types.IGroup.html" class="tsd-signature-type" data-tsd-kind="Interface">IGroup</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L23">Organizations/Groups.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
|
+
<p>Get a list of groups for a given organization. The caller must have admin access to the organization.</p>
|
|
13
|
+
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Groups</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@verdocs/js-sdk/Organizations'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">groups</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Groups</span><span class="hl-1">.</span><span class="hl-6">getGroups</span><span class="hl-1">(</span><span class="hl-5">ORGID</span><span class="hl-1">);</span>
|
|
14
|
+
</code></pre>
|
|
15
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Organizations.Types.IGroup.html" class="tsd-signature-type" data-tsd-kind="Interface">IGroup</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getMembers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Members</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Members<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, groupId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L42">Organizations/Groups.ts:42</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>groupId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class="current tsd-kind-namespace"><a href="Organizations.html">Organizations</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html">Api<wbr/>Keys</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Groups.html">Groups</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Invitations.html">Invitations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Members.html">Members</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html">Organizations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Types.html">Types</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html">Webhooks</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#addMembers" class="tsd-kind-icon">add<wbr/>Members</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#addPermission" class="tsd-kind-icon">add<wbr/>Permission</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#deleteMembers" class="tsd-kind-icon">delete<wbr/>Members</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#deletePermission" class="tsd-kind-icon">delete<wbr/>Permission</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#getGroup" class="tsd-kind-icon">get<wbr/>Group</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#getGroups" class="tsd-kind-icon">get<wbr/>Groups</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Groups.html#getMembers" class="tsd-kind-icon">get<wbr/>Members</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>
|
|
@@ -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>Invitations | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Organizations.html">Organizations</a></li><li><a href="Organizations.Invitations.html">Invitations</a></li></ul><h1>Namespace Invitations</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="Organizations.Invitations.html#claimInvitation" class="tsd-kind-icon">claim<wbr/>Invitation</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#claimNewUser" class="tsd-kind-icon">claim<wbr/>New<wbr/>User</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#createInvitation" class="tsd-kind-icon">create<wbr/>Invitation</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#deleteInvitation" class="tsd-kind-icon">delete<wbr/>Invitation</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#getInvitations" class="tsd-kind-icon">get<wbr/>Invitations</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#resendInvitation" class="tsd-kind-icon">resend<wbr/>Invitation</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#updateInvitation" class="tsd-kind-icon">update<wbr/>Invitation</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="claimInvitation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> claim<wbr/>Invitation</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">claim<wbr/>Invitation<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, email<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L28">Organizations/Invitations.ts:28</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>email: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="claimNewUser" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> claim<wbr/>New<wbr/>User</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">claim<wbr/>New<wbr/>User<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, token<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L33">Organizations/Invitations.ts:33</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>email: <span class="tsd-signature-type">string</span></h5></li><li><h5>token: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="createInvitation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Invitation</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Invitation<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L8">Organizations/Invitations.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>params: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deleteInvitation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Invitation</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Invitation<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, email<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L13">Organizations/Invitations.ts:13</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>email: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getInvitations" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Invitations</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Invitations<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L3">Organizations/Invitations.ts:3</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="resendInvitation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> resend<wbr/>Invitation</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">resend<wbr/>Invitation<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, email<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L23">Organizations/Invitations.ts:23</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>email: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="updateInvitation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> update<wbr/>Invitation</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">update<wbr/>Invitation<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, email<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L18">Organizations/Invitations.ts:18</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>email: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class="current tsd-kind-namespace"><a href="Organizations.html">Organizations</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html">Api<wbr/>Keys</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Groups.html">Groups</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Invitations.html">Invitations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Members.html">Members</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html">Organizations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Types.html">Types</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html">Webhooks</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#claimInvitation" class="tsd-kind-icon">claim<wbr/>Invitation</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#claimNewUser" class="tsd-kind-icon">claim<wbr/>New<wbr/>User</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#createInvitation" class="tsd-kind-icon">create<wbr/>Invitation</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#deleteInvitation" class="tsd-kind-icon">delete<wbr/>Invitation</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#getInvitations" class="tsd-kind-icon">get<wbr/>Invitations</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#resendInvitation" class="tsd-kind-icon">resend<wbr/>Invitation</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Invitations.html#updateInvitation" class="tsd-kind-icon">update<wbr/>Invitation</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>
|
|
@@ -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>Members | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Organizations.html">Organizations</a></li><li><a href="Organizations.Members.html">Members</a></li></ul><h1>Namespace Members</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="Organizations.Members.html#addMemberRole" class="tsd-kind-icon">add<wbr/>Member<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Members.html#deleteMember" class="tsd-kind-icon">delete<wbr/>Member</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Members.html#deleteMemberRole" class="tsd-kind-icon">delete<wbr/>Member<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Members.html#getMemberPlans" class="tsd-kind-icon">get<wbr/>Member<wbr/>Plans</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Members.html#getMembers" class="tsd-kind-icon">get<wbr/>Members</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="addMemberRole" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr/>Member<wbr/>Role</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">add<wbr/>Member<wbr/>Role<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roleId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L13">Organizations/Members.ts:13</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li><li><h5>roleId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deleteMember" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Member</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Member<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L8">Organizations/Members.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deleteMemberRole" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Member<wbr/>Role</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Member<wbr/>Role<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, roleId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L18">Organizations/Members.ts:18</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li><li><h5>roleId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getMemberPlans" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Member<wbr/>Plans</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Member<wbr/>Plans<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, profileId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L23">Organizations/Members.ts:23</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>profileId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getMembers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Members</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Members<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L3">Organizations/Members.ts:3</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class="current tsd-kind-namespace"><a href="Organizations.html">Organizations</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html">Api<wbr/>Keys</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Groups.html">Groups</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Invitations.html">Invitations</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Members.html">Members</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html">Organizations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Types.html">Types</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html">Webhooks</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Members.html#addMemberRole" class="tsd-kind-icon">add<wbr/>Member<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Members.html#deleteMember" class="tsd-kind-icon">delete<wbr/>Member</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Members.html#deleteMemberRole" class="tsd-kind-icon">delete<wbr/>Member<wbr/>Role</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Members.html#getMemberPlans" class="tsd-kind-icon">get<wbr/>Member<wbr/>Plans</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Members.html#getMembers" class="tsd-kind-icon">get<wbr/>Members</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>
|
|
@@ -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>Organizations | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Organizations.html">Organizations</a></li><li><a href="Organizations.Organizations-1.html">Organizations</a></li></ul><h1>Namespace Organizations</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="Organizations.Organizations-1.html#createOrganization" class="tsd-kind-icon">create<wbr/>Organization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#deleteOrganization" class="tsd-kind-icon">delete<wbr/>Organization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#getOrganization" class="tsd-kind-icon">get<wbr/>Organization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#getOrganizations" class="tsd-kind-icon">get<wbr/>Organizations</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#updateOrganization" class="tsd-kind-icon">update<wbr/>Organization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#validateOrganization" class="tsd-kind-icon">validate<wbr/>Organization</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="createOrganization" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Organization</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Organization<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"><</span><a href="../interfaces/Organizations.Types.IOrganization.html" class="tsd-signature-type" data-tsd-kind="Interface">IOrganization</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L9">Organizations/Organizations.ts:9</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Organizations.Types.IOrganization.html" class="tsd-signature-type" data-tsd-kind="Interface">IOrganization</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deleteOrganization" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Organization</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Organization<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L19">Organizations/Organizations.ts:19</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getOrganization" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Organization</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Organization<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L24">Organizations/Organizations.ts:24</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getOrganizations" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Organizations</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Organizations<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"><</span><a href="../interfaces/Organizations.Types.IOrganization.html" class="tsd-signature-type" data-tsd-kind="Interface">IOrganization</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L4">Organizations/Organizations.ts:4</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Organizations.Types.IOrganization.html" class="tsd-signature-type" data-tsd-kind="Interface">IOrganization</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="updateOrganization" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> update<wbr/>Organization</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">update<wbr/>Organization<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L29">Organizations/Organizations.ts:29</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>params: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="validateOrganization" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> validate<wbr/>Organization</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">validate<wbr/>Organization<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"><</span><a href="../interfaces/Organizations.Types.IOrganization.html" class="tsd-signature-type" data-tsd-kind="Interface">IOrganization</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L14">Organizations/Organizations.ts:14</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Organizations.Types.IOrganization.html" class="tsd-signature-type" data-tsd-kind="Interface">IOrganization</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class="current tsd-kind-namespace"><a href="Organizations.html">Organizations</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html">Api<wbr/>Keys</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Groups.html">Groups</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Invitations.html">Invitations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Members.html">Members</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html">Organizations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Types.html">Types</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html">Webhooks</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#createOrganization" class="tsd-kind-icon">create<wbr/>Organization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#deleteOrganization" class="tsd-kind-icon">delete<wbr/>Organization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#getOrganization" class="tsd-kind-icon">get<wbr/>Organization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#getOrganizations" class="tsd-kind-icon">get<wbr/>Organizations</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#updateOrganization" class="tsd-kind-icon">update<wbr/>Organization</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html#validateOrganization" class="tsd-kind-icon">validate<wbr/>Organization</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>
|
|
@@ -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="Organizations.html">Organizations</a></li><li><a href="Organizations.Types.html">Types</a></li></ul><h1>Namespace Types</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IApiKey.html" class="tsd-kind-icon">IApi<wbr/>Key</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IApiKeyWithSecret.html" class="tsd-kind-icon">IApi<wbr/>Key<wbr/>With<wbr/>Secret</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.ICreateApiKeyRequest.html" class="tsd-kind-icon">ICreate<wbr/>Api<wbr/>Key<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IGroup.html" class="tsd-kind-icon">IGroup</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IGroupDetail.html" class="tsd-kind-icon">IGroup<wbr/>Detail</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IOrganization.html" class="tsd-kind-icon">IOrganization</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IUpdateApiKeyRequest.html" class="tsd-kind-icon">IUpdate<wbr/>Api<wbr/>Key<wbr/>Request</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="current tsd-kind-namespace"><a href="Organizations.html">Organizations</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html">Api<wbr/>Keys</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Groups.html">Groups</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Invitations.html">Invitations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Members.html">Members</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html">Organizations</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Types.html">Types</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html">Webhooks</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IApiKey.html" class="tsd-kind-icon">IApi<wbr/>Key</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IApiKeyWithSecret.html" class="tsd-kind-icon">IApi<wbr/>Key<wbr/>With<wbr/>Secret</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.ICreateApiKeyRequest.html" class="tsd-kind-icon">ICreate<wbr/>Api<wbr/>Key<wbr/>Request</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IGroup.html" class="tsd-kind-icon">IGroup</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IGroupDetail.html" class="tsd-kind-icon">IGroup<wbr/>Detail</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IOrganization.html" class="tsd-kind-icon">IOrganization</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Organizations.Types.IUpdateApiKeyRequest.html" class="tsd-kind-icon">IUpdate<wbr/>Api<wbr/>Key<wbr/>Request</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>
|
|
@@ -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>Webhooks | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Organizations.html">Organizations</a></li><li><a href="Organizations.Webhooks.html">Webhooks</a></li></ul><h1>Namespace Webhooks</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="Organizations.Webhooks.html#getWebhook" class="tsd-kind-icon">get<wbr/>Webhook</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html#updateWebhook" class="tsd-kind-icon">update<wbr/>Webhook</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="getWebhook" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Webhook</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Webhook<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Webhooks.ts#L3">Organizations/Webhooks.ts:3</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="updateWebhook" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> update<wbr/>Webhook</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">update<wbr/>Webhook<span class="tsd-signature-symbol">(</span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Webhooks.ts#L8">Organizations/Webhooks.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>organizationId: <span class="tsd-signature-type">string</span></h5></li><li><h5>params: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="Documents.html">Documents</a></li><li class=" tsd-kind-namespace"><a href="HTTP.html">HTTP</a></li><li class="current tsd-kind-namespace"><a href="Organizations.html">Organizations</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html">Api<wbr/>Keys</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Groups.html">Groups</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Invitations.html">Invitations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Members.html">Members</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html">Organizations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Types.html">Types</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html">Webhooks</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html#getWebhook" class="tsd-kind-icon">get<wbr/>Webhook</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html#updateWebhook" class="tsd-kind-icon">update<wbr/>Webhook</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>
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Organizations | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Organizations.html">Organizations</a></li></ul><h1>Namespace Organizations</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
+
<p>An Organization is a high-level container within Verdocs that groups together Templates, Documents, Profiles, Billing, and
|
|
3
|
+
other settings. A User may be a member of more than one Organization. Each membership is tracked by a Profile representing
|
|
4
|
+
that user's settings within that organization. It is important to select the correct Profile before performing operations
|
|
5
|
+
against the Verdocs API, as this also sets the Organization that will be operated on, and the user's permissions within it.</p>
|
|
6
|
+
</div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Namespaces</h3><ul class="tsd-index-list"><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html" class="tsd-kind-icon">Api<wbr/>Keys</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Groups.html" class="tsd-kind-icon">Groups</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Invitations.html" class="tsd-kind-icon">Invitations</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Members.html" class="tsd-kind-icon">Members</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html" class="tsd-kind-icon">Organizations</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Types.html" class="tsd-kind-icon">Types</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html" class="tsd-kind-icon">Webhooks</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="current tsd-kind-namespace"><a href="Organizations.html">Organizations</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.ApiKeys.html">Api<wbr/>Keys</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Groups.html">Groups</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Invitations.html">Invitations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Members.html">Members</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Organizations-1.html">Organizations</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Types.html">Types</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="Organizations.Webhooks.html">Webhooks</a></li></ul></li><li class=" tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul></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>
|
|
@@ -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>Signatures | @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="Signatures.html">Signatures</a></li></ul><h1>Namespace Signatures</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Signatures.ISignature.html" class="tsd-kind-icon">ISignature</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Signatures.html#createSignature" class="tsd-kind-icon">create<wbr/>Signature</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Signatures.html#deleteSignature" class="tsd-kind-icon">delete<wbr/>Signature</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Signatures.html#getSignature" class="tsd-kind-icon">get<wbr/>Signature</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Signatures.html#getSignatures" class="tsd-kind-icon">get<wbr/>Signatures</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="createSignature" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Signature</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Signature<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"><</span><a href="../interfaces/Signatures.ISignature.html" class="tsd-signature-type" data-tsd-kind="Interface">ISignature</a><span class="tsd-signature-symbol">></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/Signatures.ts#L11">Signatures.ts:11</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"><</span><a href="../interfaces/Signatures.ISignature.html" class="tsd-signature-type" data-tsd-kind="Interface">ISignature</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deleteSignature" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Signature</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Signature<span class="tsd-signature-symbol">(</span>signatureId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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/Signatures.ts#L26">Signatures.ts:26</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>signatureId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getSignature" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Signature</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Signature<span class="tsd-signature-symbol">(</span>signatureId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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/Signatures.ts#L21">Signatures.ts:21</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>signatureId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getSignatures" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Signatures</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Signatures<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"><</span><a href="../interfaces/Signatures.ISignature.html" class="tsd-signature-type" data-tsd-kind="Interface">ISignature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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/Signatures.ts#L16">Signatures.ts:16</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Signatures.ISignature.html" class="tsd-signature-type" data-tsd-kind="Interface">ISignature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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="current tsd-kind-namespace"><a href="Signatures.html">Signatures</a></li><li class=" tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Signatures.ISignature.html" class="tsd-kind-icon">ISignature</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Signatures.html#createSignature" class="tsd-kind-icon">create<wbr/>Signature</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Signatures.html#deleteSignature" class="tsd-kind-icon">delete<wbr/>Signature</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Signatures.html#getSignature" class="tsd-kind-icon">get<wbr/>Signature</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Signatures.html#getSignatures" class="tsd-kind-icon">get<wbr/>Signatures</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>
|
|
@@ -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="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>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Tags.ITags.html" class="tsd-kind-icon">ITags</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Tags.html#createTag" class="tsd-kind-icon">create<wbr/>Tag</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Tags.html#getTag" class="tsd-kind-icon">get<wbr/>Tag</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Tags.html#searchTag" class="tsd-kind-icon">search<wbr/>Tag</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>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/Tags.ITags.html" class="tsd-signature-type" data-tsd-kind="Interface">ITags</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"><</span><a href="../interfaces/Tags.ITags.html" class="tsd-signature-type" data-tsd-kind="Interface">ITags</a><span class="tsd-signature-symbol">></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/Tags.ts#L9">Tags.ts:9</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../interfaces/Tags.ITags.html" class="tsd-signature-type" data-tsd-kind="Interface">ITags</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Tags.ITags.html" class="tsd-signature-type" data-tsd-kind="Interface">ITags</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Tag</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Tag<span class="tsd-signature-symbol">(</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"><</span><a href="../interfaces/Tags.ITags.html" class="tsd-signature-type" data-tsd-kind="Interface">ITags</a><span class="tsd-signature-symbol">></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/Tags.ts#L14">Tags.ts:14</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><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"><</span><a href="../interfaces/Tags.ITags.html" class="tsd-signature-type" data-tsd-kind="Interface">ITags</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="searchTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> search<wbr/>Tag</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">search<wbr/>Tag<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"><</span><a href="../interfaces/Tags.ITags.html" class="tsd-signature-type" data-tsd-kind="Interface">ITags</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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/Tags.ts#L19">Tags.ts:19</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"><</span><a href="../interfaces/Tags.ITags.html" class="tsd-signature-type" data-tsd-kind="Interface">ITags</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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="current tsd-kind-namespace"><a href="Tags.html">Tags</a></li><li class=" tsd-kind-namespace"><a href="Templates.html">Templates</a></li><li class=" tsd-kind-namespace"><a href="Users.html">Users</a></li><li class=" tsd-kind-namespace"><a href="Utils.html">Utils</a></li><li class=" tsd-kind-namespace"><a href="Validators.html">Validators</a></li><li class=" tsd-kind-namespace"><a href="Whitelabel.html">Whitelabel</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/Tags.ITags.html" class="tsd-kind-icon">ITags</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Tags.html#createTag" class="tsd-kind-icon">create<wbr/>Tag</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Tags.html#getTag" class="tsd-kind-icon">get<wbr/>Tag</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Tags.html#searchTag" class="tsd-kind-icon">search<wbr/>Tag</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>
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Documents | @verdocs/js-sdk - v1.0.12</title><meta name="description" content="Documentation for @verdocs/js-sdk - v1.0.12"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@verdocs/js-sdk - v1.0.12</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@verdocs/js-sdk - v1.0.12</a></li><li><a href="Templates.html">Templates</a></li><li><a href="Templates.Documents.html">Documents</a></li></ul><h1>Namespace Documents</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Documents.html#createDocument" class="tsd-kind-icon">create<wbr/>Document</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Documents.html#deleteDocument" class="tsd-kind-icon">delete<wbr/>Document</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Documents.html#getDocument" class="tsd-kind-icon">get<wbr/>Document</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Documents.html#getDocuments" class="tsd-kind-icon">get<wbr/>Documents</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="createDocument" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Document</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Document<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"><</span><a href="../interfaces/Templates.Types.IDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocument</a><span class="tsd-signature-symbol">></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/Documents.ts#L27">Templates/Documents.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
+
<p>Create a Document for a particular Template.</p>
|
|
3
|
+
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Documents</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@verdocs/js-sdk/Templates'</span><span class="hl-1">;</span><br/><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Documents</span><span class="hl-1">.</span><span class="hl-6">createDocument</span><span class="hl-1">(</span><span class="hl-0">templateID</span><span class="hl-1">, </span><span class="hl-0">params</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>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"><</span><a href="../interfaces/Templates.Types.IDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocument</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deleteDocument" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Document</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Document<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, documentId<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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/Documents.ts#L55">Templates/Documents.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
|
+
<p>Delete a specific Document.</p>
|
|
7
|
+
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Documents</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@verdocs/js-sdk/Templates'</span><span class="hl-1">;</span><br/><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Documents</span><span class="hl-1">.</span><span class="hl-6">deleteDocument</span><span class="hl-1">(</span><span class="hl-0">templateID</span><span class="hl-1">, </span><span class="hl-0">documentID</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>templateId: <span class="tsd-signature-type">string</span></h5></li><li><h5>documentId: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getDocument" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Document</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Document<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, documentId<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"><</span><a href="../interfaces/Templates.Types.IDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocument</a><span class="tsd-signature-symbol">></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/Documents.ts#L41">Templates/Documents.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
|
+
<p>Get a specific Document.</p>
|
|
11
|
+
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Documents</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@verdocs/js-sdk/Templates'</span><span class="hl-1">;</span><br/><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Documents</span><span class="hl-1">.</span><span class="hl-6">getDocument</span><span class="hl-1">(</span><span class="hl-0">templateID</span><span class="hl-1">, </span><span class="hl-0">documentID</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>templateId: <span class="tsd-signature-type">string</span></h5></li><li><h5>documentId: <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"><</span><a href="../interfaces/Templates.Types.IDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocument</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="getDocuments" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Documents</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Documents<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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/Documents.ts#L13">Templates/Documents.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
14
|
+
<p>Get all the Documents associated to a particular Template.</p>
|
|
15
|
+
</div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">Documents</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@verdocs/js-sdk/Templates'</span><span class="hl-1">;</span><br/><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">Documents</span><span class="hl-1">.</span><span class="hl-6">getDocuments</span><span class="hl-1">(</span><span class="hl-0">templateID</span><span class="hl-1">);</span>
|
|
16
|
+
</code></pre>
|
|
17
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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="current 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><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Documents.html#createDocument" class="tsd-kind-icon">create<wbr/>Document</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Documents.html#deleteDocument" class="tsd-kind-icon">delete<wbr/>Document</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Documents.html#getDocument" class="tsd-kind-icon">get<wbr/>Document</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Documents.html#getDocuments" class="tsd-kind-icon">get<wbr/>Documents</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>
|
|
@@ -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>Fields | @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.Fields.html">Fields</a></li></ul><h1>Namespace Fields</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.Fields.html#createField" class="tsd-kind-icon">create<wbr/>Field</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Fields.html#deleteField" class="tsd-kind-icon">delete<wbr/>Field</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Fields.html#editField" class="tsd-kind-icon">edit<wbr/>Field</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="createField" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr/>Field</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">create<wbr/>Field<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.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</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"><</span><a href="../interfaces/Templates.Types.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</a><span class="tsd-signature-symbol">></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/Fields.ts#L4">Templates/Fields.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.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Templates.Types.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="deleteField" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> delete<wbr/>Field</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Field<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fieldName<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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/Fields.ts#L14">Templates/Fields.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>fieldName: <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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a name="editField" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> edit<wbr/>Field</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">edit<wbr/>Field<span class="tsd-signature-symbol">(</span>templateId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fieldName<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.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</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"><</span><a href="../interfaces/Templates.Types.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</a><span class="tsd-signature-symbol">></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/Fields.ts#L9">Templates/Fields.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>fieldName: <span class="tsd-signature-type">string</span></h5></li><li><h5>params: <a href="../interfaces/Templates.Types.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Templates.Types.IField.html" class="tsd-signature-type" data-tsd-kind="Interface">IField</a><span class="tsd-signature-symbol">></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="current 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><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Fields.html#createField" class="tsd-kind-icon">create<wbr/>Field</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Fields.html#deleteField" class="tsd-kind-icon">delete<wbr/>Field</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Templates.Fields.html#editField" class="tsd-kind-icon">edit<wbr/>Field</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>
|