jamespot-user-api 1.0.151 → 1.0.152
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/documentation/assets/search.js +1 -1
- package/documentation/classes/AdminLicenseApi.html +11 -11
- package/documentation/classes/AdminStoreApi.html +1 -1
- package/documentation/classes/AdminUtilsApi.html +1 -1
- package/documentation/classes/JApplicationApi.html +8 -8
- package/documentation/classes/JArticleApi.html +1 -1
- package/documentation/classes/JAssetReservation.html +1 -1
- package/documentation/classes/JAudienceApi.html +1 -1
- package/documentation/classes/JBaseApi.html +1 -1
- package/documentation/classes/JBookmarkApi.html +1 -1
- package/documentation/classes/JBusinessNetworkingApi.html +1 -1
- package/documentation/classes/JCommunityApi.html +1 -1
- package/documentation/classes/JDiapazoneApi.html +1 -1
- package/documentation/classes/JFaqApi.html +1 -1
- package/documentation/classes/JFileApi.html +6 -6
- package/documentation/classes/JFilebankApi.html +1 -1
- package/documentation/classes/JGlobalApi.html +1 -1
- package/documentation/classes/JGroupApi.html +9 -9
- package/documentation/classes/JIAApi.html +1 -1
- package/documentation/classes/JLandApi.html +1 -1
- package/documentation/classes/JMessengerApi.html +1 -1
- package/documentation/classes/JObjectApi.html +1 -1
- package/documentation/classes/JSearchApi.html +6 -6
- package/documentation/classes/JShareApi.html +1 -1
- package/documentation/classes/JSocialActionApi.html +1 -1
- package/documentation/classes/JTaxonomyApi.html +2 -2
- package/documentation/classes/JUserApi.html +7 -7
- package/documentation/classes/JWedocApi.html +1 -1
- package/documentation/classes/JWidgetApi.html +1 -1
- package/documentation/classes/JamespotUserApi.html +1 -1
- package/documentation/classes/Network.html +1 -1
- package/documentation/classes/TVDisplayApi.html +1 -1
- package/documentation/classes/WindowBrowser.html +1 -1
- package/documentation/enums/StudioApplicationStatus.html +1 -1
- package/documentation/index.html +1 -1
- package/documentation/interfaces/AccessRightObject.html +1 -1
- package/documentation/interfaces/AdminLicenseUser.html +1 -1
- package/documentation/interfaces/ApiDefaultWrapper.html +1 -1
- package/documentation/interfaces/ApiWrapper.html +1 -1
- package/documentation/interfaces/BaseAutocomplete.html +1 -1
- package/documentation/interfaces/BaseMessage.html +1 -1
- package/documentation/interfaces/Category.html +1 -1
- package/documentation/interfaces/FileBankProps.html +1 -1
- package/documentation/interfaces/FolderProps.html +1 -1
- package/documentation/interfaces/ListFilterSpec.html +1 -1
- package/documentation/interfaces/OF.html +1 -1
- package/documentation/interfaces/ObjectListProps.html +1 -1
- package/documentation/interfaces/PagingResults.html +1 -1
- package/documentation/interfaces/RootFolderProps.html +1 -1
- package/documentation/interfaces/SearchCategoryModel.html +1 -1
- package/documentation/interfaces/SearchCategoryValue.html +1 -1
- package/documentation/interfaces/SearchConfig.html +1 -1
- package/documentation/interfaces/SearchFacetModel.html +1 -1
- package/documentation/interfaces/SearchFacetValueModel.html +1 -1
- package/documentation/interfaces/SearchQuery.html +1 -1
- package/documentation/interfaces/SearchQueryFilterModel.html +1 -1
- package/documentation/interfaces/SearchQueryOption.html +1 -1
- package/documentation/interfaces/SearchQueryResult.html +1 -1
- package/documentation/interfaces/SearchQuerySortModel.html +1 -1
- package/documentation/interfaces/SearchResultCatProps.html +1 -1
- package/documentation/interfaces/SearchResultPropsApp.html +1 -1
- package/documentation/interfaces/SearchResultPropsObject.html +1 -1
- package/documentation/interfaces/SpotProps.html +1 -1
- package/documentation/interfaces/TaxonomyCreate.html +1 -1
- package/documentation/interfaces/WindowInterface.html +1 -1
- package/documentation/modules.html +10 -10
- package/lib/jamespot-user-api.js +1 -1
- package/lib/jamespot-user-api.js.map +1 -1
- package/lib/src/apis/file/file.d.ts +6 -1
- package/lib/src/apis/file/file.mock.d.ts +6 -1
- package/lib/src/types/file.d.ts +6 -0
- package/lib/src/types/meeting.d.ts +1 -1
- package/lib/src/types/search.d.ts +1 -0
- package/lib/src/types/socialEvent.d.ts +1 -1
- package/package.json +1 -1
- package/phpunitMock/articleGet-meeting-view.json +5 -6
- package/phpunitMock/articleGet-socialEvent-view.json +5 -6
- package/phpunitMock/fileGeneratePreview-success.json +7 -0
- package/phpunitMock/fileGetDownload-success.json +17 -0
- package/phpunitMock/searchGetConfig-default.json +41 -10
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AdminLicenseApi | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">jamespot-user-api</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">jamespot-user-api</a></li><li><a href="AdminLicenseApi.html">AdminLicenseApi</a></li></ul><h1>Class AdminLicenseApi </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="JBaseApi.html" class="tsd-signature-type" data-tsd-kind="Class">JBaseApi</a><ul class="tsd-hierarchy"><li><span class="target">AdminLicenseApi</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="AdminLicenseApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminLicenseApi.html#jApi" class="tsd-kind-icon">j<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminLicenseApi.html#network" class="tsd-kind-icon">network</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#assignLicense" class="tsd-kind-icon">assign<wbr/>License</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#assignPossiblesLicenses" class="tsd-kind-icon">assign<wbr/>Possibles<wbr/>Licenses</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getAssignmentMode" class="tsd-kind-icon">get<wbr/>Assignment<wbr/>Mode</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getLicenseUserStatistics" class="tsd-kind-icon">get<wbr/>License<wbr/>User<wbr/>Statistics</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getLicensesAssigned" class="tsd-kind-icon">get<wbr/>Licenses<wbr/>Assigned</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getLicensesNotAssigned" class="tsd-kind-icon">get<wbr/>Licenses<wbr/>Not<wbr/>Assigned</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getObjectsWithoutLicense" class="tsd-kind-icon">get<wbr/>Objects<wbr/>Without<wbr/>License</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#optimizeLicenses" class="tsd-kind-icon">optimize<wbr/>Licenses</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#setAssignmentMode" class="tsd-kind-icon">set<wbr/>Assignment<wbr/>Mode</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#unAssignLicense" class="tsd-kind-icon">un<wbr/>Assign<wbr/>License</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#unAssignUnusedLicenses" class="tsd-kind-icon">un<wbr/>Assign<wbr/>Unused<wbr/>Licenses</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Admin<wbr/>License<wbr/>Api<span class="tsd-signature-symbol">(</span>jApi<span class="tsd-signature-symbol">: </span><a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AdminLicenseApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminLicenseApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/base.ts#L8">src/apis/base.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jApi: <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="AdminLicenseApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminLicenseApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="jApi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">j<wbr/>Api<a href="#jApi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">j<wbr/>Api<span class="tsd-signature-symbol">:</span> <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#jApi">jApi</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/base.ts#L5">src/apis/base.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="network" class="tsd-anchor"></a><h3 class="tsd-anchor-link">network<a href="#network" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="Network.html" class="tsd-signature-type" data-tsd-kind="Class">Network</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#network">network</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/base.ts#L6">src/apis/base.ts:6</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="assignLicense" class="tsd-anchor"></a><h3 class="tsd-anchor-link">assign<wbr/>License<a href="#assignLicense" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">assign<wbr/>License<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/admin/license.ts#L26">src/apis/admin/license.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AdminLicenseApi | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">jamespot-user-api</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">jamespot-user-api</a></li><li><a href="AdminLicenseApi.html">AdminLicenseApi</a></li></ul><h1>Class AdminLicenseApi </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="JBaseApi.html" class="tsd-signature-type" data-tsd-kind="Class">JBaseApi</a><ul class="tsd-hierarchy"><li><span class="target">AdminLicenseApi</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="AdminLicenseApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminLicenseApi.html#jApi" class="tsd-kind-icon">j<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminLicenseApi.html#network" class="tsd-kind-icon">network</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#assignLicense" class="tsd-kind-icon">assign<wbr/>License</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#assignPossiblesLicenses" class="tsd-kind-icon">assign<wbr/>Possibles<wbr/>Licenses</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getAssignmentMode" class="tsd-kind-icon">get<wbr/>Assignment<wbr/>Mode</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getLicenseUserStatistics" class="tsd-kind-icon">get<wbr/>License<wbr/>User<wbr/>Statistics</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getLicensesAssigned" class="tsd-kind-icon">get<wbr/>Licenses<wbr/>Assigned</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getLicensesNotAssigned" class="tsd-kind-icon">get<wbr/>Licenses<wbr/>Not<wbr/>Assigned</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#getObjectsWithoutLicense" class="tsd-kind-icon">get<wbr/>Objects<wbr/>Without<wbr/>License</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#optimizeLicenses" class="tsd-kind-icon">optimize<wbr/>Licenses</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#setAssignmentMode" class="tsd-kind-icon">set<wbr/>Assignment<wbr/>Mode</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#unAssignLicense" class="tsd-kind-icon">un<wbr/>Assign<wbr/>License</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminLicenseApi.html#unAssignUnusedLicenses" class="tsd-kind-icon">un<wbr/>Assign<wbr/>Unused<wbr/>Licenses</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Admin<wbr/>License<wbr/>Api<span class="tsd-signature-symbol">(</span>jApi<span class="tsd-signature-symbol">: </span><a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AdminLicenseApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminLicenseApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/base.ts#L8">src/apis/base.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jApi: <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="AdminLicenseApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminLicenseApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="jApi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">j<wbr/>Api<a href="#jApi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">j<wbr/>Api<span class="tsd-signature-symbol">:</span> <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#jApi">jApi</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/base.ts#L5">src/apis/base.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="network" class="tsd-anchor"></a><h3 class="tsd-anchor-link">network<a href="#network" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="Network.html" class="tsd-signature-type" data-tsd-kind="Class">Network</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#network">network</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/base.ts#L6">src/apis/base.ts:6</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="assignLicense" class="tsd-anchor"></a><h3 class="tsd-anchor-link">assign<wbr/>License<a href="#assignLicense" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">assign<wbr/>License<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L26">src/apis/admin/license.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>Assigns a license to the content with the provided uri (if any is available)</p>
|
|
3
3
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
4
|
<p>URI of the object to which a license must be assigned</p>
|
|
5
5
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>boolean</p>
|
|
6
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="assignPossiblesLicenses" class="tsd-anchor"></a><h3 class="tsd-anchor-link">assign<wbr/>Possibles<wbr/>Licenses<a href="#assignPossiblesLicenses" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">assign<wbr/>Possibles<wbr/>Licenses<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
6
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="assignPossiblesLicenses" class="tsd-anchor"></a><h3 class="tsd-anchor-link">assign<wbr/>Possibles<wbr/>Licenses<a href="#assignPossiblesLicenses" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">assign<wbr/>Possibles<wbr/>Licenses<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L80">src/apis/admin/license.ts:80</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
7
7
|
<p>Assign the available licenses</p>
|
|
8
8
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
9
9
|
<p>the type of licenses for which we will assign the remaining available one</p>
|
|
10
10
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>boolean</p>
|
|
11
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAssignmentMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Assignment<wbr/>Mode<a href="#getAssignmentMode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Assignment<wbr/>Mode<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
11
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAssignmentMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Assignment<wbr/>Mode<a href="#getAssignmentMode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Assignment<wbr/>Mode<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L52">src/apis/admin/license.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
12
|
<p>Retrieve the assignment license user mode between automatic | manual</p>
|
|
13
13
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
14
14
|
<p>retrieve the automatic license assignation</p>
|
|
15
15
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>a string who's the current assignment selected</p>
|
|
16
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLicenseUserStatistics" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>License<wbr/>User<wbr/>Statistics<a href="#getLicenseUserStatistics" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>License<wbr/>User<wbr/>Statistics<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicenseUserStats" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicenseUserStats</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
16
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLicenseUserStatistics" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>License<wbr/>User<wbr/>Statistics<a href="#getLicenseUserStatistics" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>License<wbr/>User<wbr/>Statistics<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicenseUserStats" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicenseUserStats</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L14">src/apis/admin/license.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
17
17
|
<p>Retrieve the user licenses stats</p>
|
|
18
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicenseUserStats" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicenseUserStats</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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-method tsd-parent-kind-class"><a id="getLicensesAssigned" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Licenses<wbr/>Assigned<a href="#getLicensesAssigned" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Licenses<wbr/>Assigned<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicensesAssigned" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicensesAssigned</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
18
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicenseUserStats" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicenseUserStats</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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-method tsd-parent-kind-class"><a id="getLicensesAssigned" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Licenses<wbr/>Assigned<a href="#getLicensesAssigned" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Licenses<wbr/>Assigned<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicensesAssigned" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicensesAssigned</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L151">src/apis/admin/license.ts:151</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
19
19
|
<p>Retireve the list of licenses assigned to content of a given type</p>
|
|
20
20
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
21
21
|
<p>type of content for which we want to retrieve the licenses</p>
|
|
22
22
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicensesAssigned" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicensesAssigned</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>The list of licenses assigned to content of the provided type</p>
|
|
23
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLicensesNotAssigned" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Licenses<wbr/>Not<wbr/>Assigned<a href="#getLicensesNotAssigned" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Licenses<wbr/>Not<wbr/>Assigned<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicensesNotAssigned" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicensesNotAssigned</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
23
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLicensesNotAssigned" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Licenses<wbr/>Not<wbr/>Assigned<a href="#getLicensesNotAssigned" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Licenses<wbr/>Not<wbr/>Assigned<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicensesNotAssigned" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicensesNotAssigned</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L137">src/apis/admin/license.ts:137</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
24
24
|
<p>Retireve the list of licenses assigned to content of a given type</p>
|
|
25
25
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
26
26
|
<p>type of content for which we want to retrieve the licenses not assigned</p>
|
|
27
27
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminLicensesNotAssigned" class="tsd-signature-type" data-tsd-kind="Type alias">AdminLicensesNotAssigned</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>The number of licenses depending on the type used as param</p>
|
|
28
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getObjectsWithoutLicense" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Objects<wbr/>Without<wbr/>License<a href="#getObjectsWithoutLicense" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Objects<wbr/>Without<wbr/>License<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filter<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ObjectWithoutLicenseFilter" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectWithoutLicenseFilter</a><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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
28
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getObjectsWithoutLicense" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Objects<wbr/>Without<wbr/>License<a href="#getObjectsWithoutLicense" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Objects<wbr/>Without<wbr/>License<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filter<span class="tsd-signature-symbol">?: </span><a href="../modules.html#ObjectWithoutLicenseFilter" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectWithoutLicenseFilter</a><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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L122">src/apis/admin/license.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
29
29
|
<p>Retrieves the number of licenses of a given type available. License type is
|
|
30
30
|
different from the content type to which it can be assigned to.</p>
|
|
31
31
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
@@ -33,24 +33,24 @@ different from the content type to which it can be assigned to.</p>
|
|
|
33
33
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> filter: <a href="../modules.html#ObjectWithoutLicenseFilter" class="tsd-signature-type" data-tsd-kind="Type alias">ObjectWithoutLicenseFilter</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
34
34
|
<p>the filters array the request can be called with</p>
|
|
35
35
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>A promise with the number of object without license</p>
|
|
36
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="optimizeLicenses" class="tsd-anchor"></a><h3 class="tsd-anchor-link">optimize<wbr/>Licenses<a href="#optimizeLicenses" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">optimize<wbr/>Licenses<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
36
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="optimizeLicenses" class="tsd-anchor"></a><h3 class="tsd-anchor-link">optimize<wbr/>Licenses<a href="#optimizeLicenses" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">optimize<wbr/>Licenses<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L106">src/apis/admin/license.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
37
37
|
<p>Assign available licenses and unassign license for inactive users</p>
|
|
38
38
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
39
39
|
<p>the type of licenses for which we will unassign and assign the possible licenses</p>
|
|
40
40
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>boolean</p>
|
|
41
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setAssignmentMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Assignment<wbr/>Mode<a href="#setAssignmentMode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Assignment<wbr/>Mode<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, assignmentMode<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
41
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setAssignmentMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Assignment<wbr/>Mode<a href="#setAssignmentMode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Assignment<wbr/>Mode<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, assignmentMode<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L66">src/apis/admin/license.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
42
42
|
<p>Change the mode which the license are affected to the users</p>
|
|
43
43
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
44
44
|
<p>the type of license that would automatically be assigned</p>
|
|
45
45
|
</div></div></li><li><h5>assignmentMode: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
46
46
|
<p>the mode which the license are affected (automatic | manual)</p>
|
|
47
47
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>boolean</p>
|
|
48
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unAssignLicense" class="tsd-anchor"></a><h3 class="tsd-anchor-link">un<wbr/>Assign<wbr/>License<a href="#unAssignLicense" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">un<wbr/>Assign<wbr/>License<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
48
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unAssignLicense" class="tsd-anchor"></a><h3 class="tsd-anchor-link">un<wbr/>Assign<wbr/>License<a href="#unAssignLicense" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">un<wbr/>Assign<wbr/>License<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L39">src/apis/admin/license.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
49
49
|
<p>Unassigns the license linked to the content with the provided uri</p>
|
|
50
50
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
51
51
|
<p>URI of the object to which a license must be unassigned</p>
|
|
52
52
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div><p>boolean</p>
|
|
53
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unAssignUnusedLicenses" class="tsd-anchor"></a><h3 class="tsd-anchor-link">un<wbr/>Assign<wbr/>Unused<wbr/>Licenses<a href="#unAssignUnusedLicenses" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">un<wbr/>Assign<wbr/>Unused<wbr/>Licenses<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/
|
|
53
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unAssignUnusedLicenses" class="tsd-anchor"></a><h3 class="tsd-anchor-link">un<wbr/>Assign<wbr/>Unused<wbr/>Licenses<a href="#unAssignUnusedLicenses" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">un<wbr/>Assign<wbr/>Unused<wbr/>Licenses<span class="tsd-signature-symbol">(</span>type<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/license.ts#L93">src/apis/admin/license.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
54
54
|
<p>Unassign licenses for inactive users</p>
|
|
55
55
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
56
56
|
<p>the type of licenses for which we will unassign upon inactive user</p>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AdminStoreApi | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">jamespot-user-api</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">jamespot-user-api</a></li><li><a href="AdminStoreApi.html">AdminStoreApi</a></li></ul><h1>Class AdminStoreApi </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="JBaseApi.html" class="tsd-signature-type" data-tsd-kind="Class">JBaseApi</a><ul class="tsd-hierarchy"><li><span class="target">AdminStoreApi</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#jApi" class="tsd-kind-icon">j<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#network" class="tsd-kind-icon">network</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#checkoutBilling" class="tsd-kind-icon">checkout<wbr/>Billing</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#checkoutFinalize" class="tsd-kind-icon">checkout<wbr/>Finalize</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#getItem" class="tsd-kind-icon">get<wbr/>Item</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Admin<wbr/>Store<wbr/>Api<span class="tsd-signature-symbol">(</span>jApi<span class="tsd-signature-symbol">: </span><a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AdminStoreApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminStoreApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/base.ts#L8">src/apis/base.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jApi: <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="AdminStoreApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminStoreApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="jApi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">j<wbr/>Api<a href="#jApi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">j<wbr/>Api<span class="tsd-signature-symbol">:</span> <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#jApi">jApi</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/base.ts#L5">src/apis/base.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="network" class="tsd-anchor"></a><h3 class="tsd-anchor-link">network<a href="#network" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="Network.html" class="tsd-signature-type" data-tsd-kind="Class">Network</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#network">network</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/base.ts#L6">src/apis/base.ts:6</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="checkoutBilling" class="tsd-anchor"></a><h3 class="tsd-anchor-link">checkout<wbr/>Billing<a href="#checkoutBilling" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">checkout<wbr/>Billing<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/admin/store.ts#L13">src/apis/admin/store.ts:13</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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-method tsd-parent-kind-class"><a id="checkoutFinalize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">checkout<wbr/>Finalize<a href="#checkoutFinalize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">checkout<wbr/>Finalize<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#StoreFinalize" class="tsd-signature-type" data-tsd-kind="Type alias">StoreFinalize</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/admin/store.ts#L20">src/apis/admin/store.ts:20</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#StoreFinalize" class="tsd-signature-type" data-tsd-kind="Type alias">StoreFinalize</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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-method tsd-parent-kind-class"><a id="getItem" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Item<a href="#getItem" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Item<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#StoreItem" class="tsd-signature-type" data-tsd-kind="Type alias">StoreItem</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/499d3a5/src/apis/admin/store.ts#L6">src/apis/admin/store.ts:6</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#StoreItem" class="tsd-signature-type" data-tsd-kind="Type alias">StoreItem</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="AdminStoreApi.html" class="tsd-kind-icon">Admin<wbr/>Store<wbr/>Api</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#jApi" class="tsd-kind-icon">j<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#network" class="tsd-kind-icon">network</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#checkoutBilling" class="tsd-kind-icon">checkout<wbr/>Billing</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#checkoutFinalize" class="tsd-kind-icon">checkout<wbr/>Finalize</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#getItem" class="tsd-kind-icon">get<wbr/>Item</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AdminStoreApi | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">jamespot-user-api</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">jamespot-user-api</a></li><li><a href="AdminStoreApi.html">AdminStoreApi</a></li></ul><h1>Class AdminStoreApi </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="JBaseApi.html" class="tsd-signature-type" data-tsd-kind="Class">JBaseApi</a><ul class="tsd-hierarchy"><li><span class="target">AdminStoreApi</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#jApi" class="tsd-kind-icon">j<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#network" class="tsd-kind-icon">network</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#checkoutBilling" class="tsd-kind-icon">checkout<wbr/>Billing</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#checkoutFinalize" class="tsd-kind-icon">checkout<wbr/>Finalize</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#getItem" class="tsd-kind-icon">get<wbr/>Item</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Admin<wbr/>Store<wbr/>Api<span class="tsd-signature-symbol">(</span>jApi<span class="tsd-signature-symbol">: </span><a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AdminStoreApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminStoreApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/base.ts#L8">src/apis/base.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jApi: <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="AdminStoreApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminStoreApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="jApi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">j<wbr/>Api<a href="#jApi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">j<wbr/>Api<span class="tsd-signature-symbol">:</span> <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#jApi">jApi</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/base.ts#L5">src/apis/base.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="network" class="tsd-anchor"></a><h3 class="tsd-anchor-link">network<a href="#network" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="Network.html" class="tsd-signature-type" data-tsd-kind="Class">Network</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#network">network</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/base.ts#L6">src/apis/base.ts:6</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="checkoutBilling" class="tsd-anchor"></a><h3 class="tsd-anchor-link">checkout<wbr/>Billing<a href="#checkoutBilling" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">checkout<wbr/>Billing<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/store.ts#L13">src/apis/admin/store.ts:13</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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-method tsd-parent-kind-class"><a id="checkoutFinalize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">checkout<wbr/>Finalize<a href="#checkoutFinalize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">checkout<wbr/>Finalize<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#StoreFinalize" class="tsd-signature-type" data-tsd-kind="Type alias">StoreFinalize</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/store.ts#L20">src/apis/admin/store.ts:20</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#StoreFinalize" class="tsd-signature-type" data-tsd-kind="Type alias">StoreFinalize</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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-method tsd-parent-kind-class"><a id="getItem" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Item<a href="#getItem" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Item<span class="tsd-signature-symbol">(</span>uri<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#StoreItem" class="tsd-signature-type" data-tsd-kind="Type alias">StoreItem</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/store.ts#L6">src/apis/admin/store.ts:6</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#StoreItem" class="tsd-signature-type" data-tsd-kind="Type alias">StoreItem</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="AdminStoreApi.html" class="tsd-kind-icon">Admin<wbr/>Store<wbr/>Api</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#jApi" class="tsd-kind-icon">j<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminStoreApi.html#network" class="tsd-kind-icon">network</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#checkoutBilling" class="tsd-kind-icon">checkout<wbr/>Billing</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#checkoutFinalize" class="tsd-kind-icon">checkout<wbr/>Finalize</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminStoreApi.html#getItem" class="tsd-kind-icon">get<wbr/>Item</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AdminUtilsApi | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">jamespot-user-api</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">jamespot-user-api</a></li><li><a href="AdminUtilsApi.html">AdminUtilsApi</a></li></ul><h1>Class AdminUtilsApi </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="JBaseApi.html" class="tsd-signature-type" data-tsd-kind="Class">JBaseApi</a><ul class="tsd-hierarchy"><li><span class="target">AdminUtilsApi</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="AdminUtilsApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminUtilsApi.html#jApi" class="tsd-kind-icon">j<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminUtilsApi.html#network" class="tsd-kind-icon">network</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminUtilsApi.html#getApps" class="tsd-kind-icon">get<wbr/>Apps</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Admin<wbr/>Utils<wbr/>Api<span class="tsd-signature-symbol">(</span>jApi<span class="tsd-signature-symbol">: </span><a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AdminUtilsApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminUtilsApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AdminUtilsApi | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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">jamespot-user-api</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">jamespot-user-api</a></li><li><a href="AdminUtilsApi.html">AdminUtilsApi</a></li></ul><h1>Class AdminUtilsApi </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="JBaseApi.html" class="tsd-signature-type" data-tsd-kind="Class">JBaseApi</a><ul class="tsd-hierarchy"><li><span class="target">AdminUtilsApi</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="AdminUtilsApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminUtilsApi.html#jApi" class="tsd-kind-icon">j<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminUtilsApi.html#network" class="tsd-kind-icon">network</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminUtilsApi.html#getApps" class="tsd-kind-icon">get<wbr/>Apps</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Admin<wbr/>Utils<wbr/>Api<span class="tsd-signature-symbol">(</span>jApi<span class="tsd-signature-symbol">: </span><a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AdminUtilsApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminUtilsApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/base.ts#L8">src/apis/base.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jApi: <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="AdminUtilsApi.html" class="tsd-signature-type" data-tsd-kind="Class">AdminUtilsApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="jApi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">j<wbr/>Api<a href="#jApi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">j<wbr/>Api<span class="tsd-signature-symbol">:</span> <a href="JamespotUserApi.html" class="tsd-signature-type" data-tsd-kind="Class">JamespotUserApi</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#jApi">jApi</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/base.ts#L5">src/apis/base.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="network" class="tsd-anchor"></a><h3 class="tsd-anchor-link">network<a href="#network" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="Network.html" class="tsd-signature-type" data-tsd-kind="Class">Network</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#network">network</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/base.ts#L6">src/apis/base.ts:6</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getApps" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Apps<a href="#getApps" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Apps<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/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminApps" class="tsd-signature-type" data-tsd-kind="Type alias">AdminApps</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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/Jamespot/jamespot-user-api/blob/23f10e6/src/apis/admin/utils.ts#L9">src/apis/admin/utils.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>Request the admin applications and sub applications for the admin panel</p>
|
|
3
3
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#AdminApps" class="tsd-signature-type" data-tsd-kind="Type alias">AdminApps</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="AdminUtilsApi.html" class="tsd-kind-icon">Admin<wbr/>Utils<wbr/>Api</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="AdminUtilsApi.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminUtilsApi.html#jApi" class="tsd-kind-icon">j<wbr/>Api</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="AdminUtilsApi.html#network" class="tsd-kind-icon">network</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AdminUtilsApi.html#getApps" class="tsd-kind-icon">get<wbr/>Apps</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|