ec.fdk 0.6.4 → 0.7.0
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/README.md +7 -34
- package/dist/index.cjs +3 -3
- package/dist/index.d.ts +10 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +458 -402
- package/dist/lib/admin.d.ts +42 -17
- package/dist/lib/admin.d.ts.map +1 -1
- package/dist/lib/api.d.ts +236 -167
- package/dist/lib/api.d.ts.map +1 -1
- package/dist/lib/assets.d.ts +13 -8
- package/dist/lib/assets.d.ts.map +1 -1
- package/dist/lib/auth.d.ts +12 -2
- package/dist/lib/auth.d.ts.map +1 -1
- package/dist/lib/entries.d.ts +40 -30
- package/dist/lib/entries.d.ts.map +1 -1
- package/dist/lib/util.d.ts +11 -0
- package/dist/lib/util.d.ts.map +1 -1
- package/dist/types.d.ts +24 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +3 -2
- package/typedoc.json +67 -0
- package/docs/.nojekyll +0 -1
- package/docs/assets/hierarchy.js +0 -1
- package/docs/assets/highlight.css +0 -85
- package/docs/assets/icons.js +0 -18
- package/docs/assets/icons.svg +0 -1
- package/docs/assets/main.js +0 -60
- package/docs/assets/navigation.js +0 -1
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1610
- package/docs/classes/Sdk.html +0 -181
- package/docs/functions/act.html +0 -1
- package/docs/functions/apiURL.html +0 -1
- package/docs/functions/assetList.html +0 -1
- package/docs/functions/createAsset.html +0 -1
- package/docs/functions/createEntry.html +0 -1
- package/docs/functions/deleteAsset.html +0 -1
- package/docs/functions/deleteEntry.html +0 -1
- package/docs/functions/deleteEntryObject.html +0 -1
- package/docs/functions/dmList.html +0 -1
- package/docs/functions/editEntry.html +0 -1
- package/docs/functions/editEntryObject.html +0 -1
- package/docs/functions/entryList.html +0 -1
- package/docs/functions/expect.html +0 -1
- package/docs/functions/fdk.html +0 -1
- package/docs/functions/fetcher.html +0 -1
- package/docs/functions/filterOptions.html +0 -3
- package/docs/functions/getAsset.html +0 -1
- package/docs/functions/getDatamanager.html +0 -1
- package/docs/functions/getEcAuthKey.html +0 -1
- package/docs/functions/getEntry.html +0 -1
- package/docs/functions/getEntryAsset.html +0 -3
- package/docs/functions/getEntryEnv.html +0 -2
- package/docs/functions/getEntryShortID.html +0 -2
- package/docs/functions/getPublicAuthKey.html +0 -1
- package/docs/functions/getSchema.html +0 -1
- package/docs/functions/loginEc.html +0 -1
- package/docs/functions/loginPublic.html +0 -1
- package/docs/functions/logoutEc.html +0 -1
- package/docs/functions/logoutPublic.html +0 -1
- package/docs/functions/mapEntries.html +0 -1
- package/docs/functions/modelList.html +0 -1
- package/docs/functions/publicApi.html +0 -1
- package/docs/functions/query.html +0 -1
- package/docs/functions/raw.html +0 -1
- package/docs/functions/resourceList.html +0 -1
- package/docs/functions/sdk-1.html +0 -1
- package/docs/functions/sdkOptions.html +0 -3
- package/docs/index.html +0 -80
- package/docs/modules.html +0 -1
- package/docs/variables/apis.html +0 -1
package/docs/classes/Sdk.html
DELETED
|
@@ -1,181 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Sdk | ec.fdk</title><meta name="description" content="Documentation for ec.fdk"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">ec.fdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">ec.fdk</a></li><li><a href="Sdk.html">Sdk</a></li></ul><h1>Class Sdk</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>SDK</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L50">api.ts:50</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Sdk.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Sdk.html#config" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a>
|
|
4
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Sdk.html#assetgroup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assetgroup</span></a>
|
|
5
|
-
<a href="Sdk.html#assetgroup-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>asset<wbr/>Group</span></a>
|
|
6
|
-
<a href="Sdk.html#assetlist" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>asset<wbr/>List</span></a>
|
|
7
|
-
<a href="Sdk.html#assets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assets</span></a>
|
|
8
|
-
<a href="Sdk.html#createasset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Asset</span></a>
|
|
9
|
-
<a href="Sdk.html#createentry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Entry</span></a>
|
|
10
|
-
<a href="Sdk.html#deleteasset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset</span></a>
|
|
11
|
-
<a href="Sdk.html#deleteentry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Entry</span></a>
|
|
12
|
-
<a href="Sdk.html#dm" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dm</span></a>
|
|
13
|
-
<a href="Sdk.html#dmid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dmID</span></a>
|
|
14
|
-
<a href="Sdk.html#dmlist" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dm<wbr/>List</span></a>
|
|
15
|
-
<a href="Sdk.html#dmshortid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dm<wbr/>ShortID</span></a>
|
|
16
|
-
<a href="Sdk.html#editentry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Entry</span></a>
|
|
17
|
-
<a href="Sdk.html#editentrysafe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Entry<wbr/>Safe</span></a>
|
|
18
|
-
<a href="Sdk.html#entries" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>entries</span></a>
|
|
19
|
-
<a href="Sdk.html#entrylist" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>entry<wbr/>List</span></a>
|
|
20
|
-
<a href="Sdk.html#getasset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a>
|
|
21
|
-
<a href="Sdk.html#getauth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Auth</span></a>
|
|
22
|
-
<a href="Sdk.html#getbesttoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Best<wbr/>Token</span></a>
|
|
23
|
-
<a href="Sdk.html#getdatamanager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Datamanager</span></a>
|
|
24
|
-
<a href="Sdk.html#getectoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Ec<wbr/>Token</span></a>
|
|
25
|
-
<a href="Sdk.html#getentry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Entry</span></a>
|
|
26
|
-
<a href="Sdk.html#getpublictoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Public<wbr/>Token</span></a>
|
|
27
|
-
<a href="Sdk.html#getschema" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Schema</span></a>
|
|
28
|
-
<a href="Sdk.html#hasanytoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Any<wbr/>Token</span></a>
|
|
29
|
-
<a href="Sdk.html#hasectoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Ec<wbr/>Token</span></a>
|
|
30
|
-
<a href="Sdk.html#haspublictoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Public<wbr/>Token</span></a>
|
|
31
|
-
<a href="Sdk.html#loginec" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>login<wbr/>Ec</span></a>
|
|
32
|
-
<a href="Sdk.html#loginpublic" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>login<wbr/>Public</span></a>
|
|
33
|
-
<a href="Sdk.html#logoutec" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>logout<wbr/>Ec</span></a>
|
|
34
|
-
<a href="Sdk.html#logoutpublic" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>logout<wbr/>Public</span></a>
|
|
35
|
-
<a href="Sdk.html#mapentries" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>map<wbr/>Entries</span></a>
|
|
36
|
-
<a href="Sdk.html#model" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>model</span></a>
|
|
37
|
-
<a href="Sdk.html#modellist" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>model<wbr/>List</span></a>
|
|
38
|
-
<a href="Sdk.html#publicapi" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>public<wbr/>Api</span></a>
|
|
39
|
-
<a href="Sdk.html#raw" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>raw</span></a>
|
|
40
|
-
<a href="Sdk.html#resource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resource</span></a>
|
|
41
|
-
<a href="Sdk.html#resourcelist" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resource<wbr/>List</span></a>
|
|
42
|
-
<a href="Sdk.html#route" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>route</span></a>
|
|
43
|
-
<a href="Sdk.html#set" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a>
|
|
44
|
-
<a href="Sdk.html#setauth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Auth</span></a>
|
|
45
|
-
<a href="Sdk.html#storageadapter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>storage<wbr/>Adapter</span></a>
|
|
46
|
-
<a href="Sdk.html#subdomain" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subdomain</span></a>
|
|
47
|
-
<a href="Sdk.html#token" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>token</span></a>
|
|
48
|
-
<a href="Sdk.html#unsetauth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unset<wbr/>Auth</span></a>
|
|
49
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorsdk" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Sdk</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#constructorsdk" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L52">api.ts:52</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L51">api.ts:51</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="assetgroup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>assetgroup</span><a href="#assetgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assetgroup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">assetgroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetGroup</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#assetgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the name of the asset group to use. Alias for <code>assetGroup</code></p>
|
|
50
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetGroup</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>name of the asset group</p>
|
|
51
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
52
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L416">api.ts:416</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="assetgroup-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset<wbr/>Group</span><a href="#assetgroup-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assetgroup-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">assetGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetGroup</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#assetgroup-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the name of the asset group to use.</p>
|
|
53
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetGroup</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>name of the asset group</p>
|
|
54
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
55
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L408">api.ts:408</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="assetlist" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>asset<wbr/>List</span><a href="#assetlist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assetlist-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">assetList</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#assetlist-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L156">api.ts:156</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="assets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>assets</span><a href="#assets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">assets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#assets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads asset list. Expects <code>dmShortID</code> / <code>assetGroup</code> to be set.
|
|
56
|
-
If the assetGroup is not public, you also need to provide a <code>token</code>.</p>
|
|
57
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>options for entry list request.</p>
|
|
58
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">// public assetGroup</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">files</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">assetGroup</span><span class="hl-1">(</span><span class="hl-2">"avatars"</span><span class="hl-1">).</span><span class="hl-0">assets</span><span class="hl-1">()</span>
|
|
59
|
-
</code><button type="button">Copy</button></pre>
|
|
60
|
-
|
|
61
|
-
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-1" class="tsd-anchor"></a>Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">// non-public assetGroup</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">files</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">token</span><span class="hl-1">(</span><span class="hl-4">token</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">assetGroup</span><span class="hl-1">(</span><span class="hl-2">"avatars"</span><span class="hl-1">).</span><span class="hl-0">assets</span><span class="hl-1">()</span>
|
|
62
|
-
</code><button type="button">Copy</button></pre>
|
|
63
|
-
|
|
64
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L152">api.ts:152</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createasset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Asset</span><a href="#createasset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createasset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createAsset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#createasset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Uploads an asset. Expects <code>dmShortID</code> / <code>assetGroup</code> / <code>file</code> to be set.
|
|
65
|
-
If the assetGroup is not public, you also need to provide a <code>token</code>.</p>
|
|
66
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>options for entry list request.</p>
|
|
67
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-2" class="tsd-anchor"></a>Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">// browser example</span><br/><span class="hl-4">document</span><span class="hl-1">.</span><span class="hl-0">getElementById</span><span class="hl-1">(</span><span class="hl-2">"file"</span><span class="hl-1">).</span><span class="hl-0">addEventListener</span><span class="hl-1">(</span><span class="hl-2">"input"</span><span class="hl-1">, </span><span class="hl-6">async</span><span class="hl-1"> (</span><span class="hl-4">e</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> [</span><span class="hl-7">file</span><span class="hl-1">] = </span><span class="hl-4">e</span><span class="hl-1">.</span><span class="hl-4">target</span><span class="hl-1">.</span><span class="hl-4">files</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">asset</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">ecadmin</span><span class="hl-1">.</span><span class="hl-0">assetgroup</span><span class="hl-1">(</span><span class="hl-2">"test"</span><span class="hl-1">).</span><span class="hl-0">createAsset</span><span class="hl-1">({ </span><span class="hl-4">file</span><span class="hl-1"> })</span><br/><span class="hl-1">});</span>
|
|
68
|
-
</code><button type="button">Copy</button></pre>
|
|
69
|
-
|
|
70
|
-
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-3" class="tsd-anchor"></a>Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">// node example</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">buf</span><span class="hl-1"> = </span><span class="hl-4">fs</span><span class="hl-1">.</span><span class="hl-0">readFileSync</span><span class="hl-1">(</span><span class="hl-2">"venndiagram.png"</span><span class="hl-1">);</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">file</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Blob</span><span class="hl-1">([</span><span class="hl-4">buf</span><span class="hl-1">]);</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">upload</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">)</span><br/><span class="hl-1">.</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">)</span><br/><span class="hl-1">.</span><span class="hl-0">assetgroup</span><span class="hl-1">(</span><span class="hl-2">"test"</span><span class="hl-1">)</span><br/><span class="hl-1">.</span><span class="hl-0">createAsset</span><span class="hl-1">({ </span><span class="hl-4">file</span><span class="hl-1">, </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">"venndiagram.png"</span><span class="hl-1"> });</span>
|
|
71
|
-
</code><button type="button">Copy</button></pre>
|
|
72
|
-
|
|
73
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L180">api.ts:180</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createentry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Entry</span><a href="#createentry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createentry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createEntry</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#createentry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new entry. Expects <code>dmShortID</code> / <code>model</code> to be set.
|
|
74
|
-
If model POST is not public, you also need to provide a <code>token</code>.</p>
|
|
75
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>values to set.</p>
|
|
76
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-4" class="tsd-anchor"></a>Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">entry</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">model</span><span class="hl-1">(</span><span class="hl-2">"muffin"</span><span class="hl-1">).</span><span class="hl-0">createEntry</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">'test'</span><span class="hl-1"> })</span>
|
|
77
|
-
</code><button type="button">Copy</button></pre>
|
|
78
|
-
|
|
79
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L220">api.ts:220</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteasset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Asset</span><a href="#deleteasset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteasset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteAsset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteasset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes an asset. Expects <code>dmShortID</code> / <code>assetGroup</code> / <code>assetID</code> to be set.
|
|
80
|
-
You probably also need to provide a <code>token</code>.</p>
|
|
81
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetID</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-5" class="tsd-anchor"></a>Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">ecadmin</span><span class="hl-1">.</span><span class="hl-0">assetgroup</span><span class="hl-1">(</span><span class="hl-2">"test"</span><span class="hl-1">).</span><span class="hl-0">deleteAsset</span><span class="hl-1">(</span><span class="hl-2">'xxxx'</span><span class="hl-1">);</span>
|
|
82
|
-
</code><button type="button">Copy</button></pre>
|
|
83
|
-
|
|
84
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L193">api.ts:193</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteentry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Entry</span><a href="#deleteentry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteentry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteEntry</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entryID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#deleteentry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes an entry. Expects <code>dmShortID</code> / <code>model</code> to be set.
|
|
85
|
-
If model DELETE is not public, you also need to provide a <code>token</code>.</p>
|
|
86
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entryID</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>id of entry to delete</p>
|
|
87
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-6" class="tsd-anchor"></a>Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">model</span><span class="hl-1">(</span><span class="hl-2">"muffin"</span><span class="hl-1">).</span><span class="hl-0">deleteEntry</span><span class="hl-1">(</span><span class="hl-2">"1gOtzWvrdq"</span><span class="hl-1">)</span>
|
|
88
|
-
</code><button type="button">Copy</button></pre>
|
|
89
|
-
|
|
90
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L247">api.ts:247</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dm" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dm</span><a href="#dm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dm-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dm</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dmShortID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#dm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the short ID of the datamanager to use. Alias for <code>dmShortID</code></p>
|
|
91
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dmShortID</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
92
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L400">api.ts:400</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dmid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dmID</span><a href="#dmid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dmid-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dmID</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dmID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#dmid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the (long) ID of the datamanager to use</p>
|
|
93
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dmID</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
94
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L392">api.ts:392</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dmlist" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dm<wbr/>List</span><a href="#dmlist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dmlist-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dmList</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <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><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#dmlist-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads datamanager list. Make sure to provide an ec.admin <code>token</code> intercept one.</p>
|
|
95
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>options for entry list request.</p>
|
|
96
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-7" class="tsd-anchor"></a>Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">dms</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dmList</span><span class="hl-1">()</span>
|
|
97
|
-
</code><button type="button">Copy</button></pre>
|
|
98
|
-
|
|
99
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L469">api.ts:469</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dmshortid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dm<wbr/>ShortID</span><a href="#dmshortid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dmshortid-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dmShortID</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dmShortID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#dmshortid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the short ID of the datamanager to use</p>
|
|
100
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dmShortID</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
101
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L384">api.ts:384</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="editentry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>edit<wbr/>Entry</span><a href="#editentry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="editentry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">editEntry</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entryID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#editentry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Edits an entry. Expects <code>dmShortID</code> / <code>model</code> to be set.
|
|
102
|
-
If model PUT is not public, you also need to provide a <code>token</code>.</p>
|
|
103
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entryID</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>id of entry to edit</p>
|
|
104
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>values to set. undefined fields are ignored</p>
|
|
105
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-8" class="tsd-anchor"></a>Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">entry</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">model</span><span class="hl-1">(</span><span class="hl-2">"muffin"</span><span class="hl-1">).</span><span class="hl-0">editEntry</span><span class="hl-1">(</span><span class="hl-2">"1gOtzWvrdq"</span><span class="hl-1">, { </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">"test"</span><span class="hl-1"> })</span>
|
|
106
|
-
</code><button type="button">Copy</button></pre>
|
|
107
|
-
|
|
108
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L234">api.ts:234</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="editentrysafe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>edit<wbr/>Entry<wbr/>Safe</span><a href="#editentrysafe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="editentrysafe-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">editEntrySafe</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entryID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#editentrysafe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Edits an entry with safe put. Expects <code>dmShortID</code> / <code>model</code> to be set.
|
|
109
|
-
Expects a <code>_modified</code> field in the value. Will only update if the entry has not been changed since.
|
|
110
|
-
If model PUT is not public, you also need to provide a <code>token</code>.</p>
|
|
111
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entryID</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>id of entry to edit</p>
|
|
112
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>values to set. undefined fields are ignored</p>
|
|
113
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-9" class="tsd-anchor"></a>Example<a href="#example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">entry</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">model</span><span class="hl-1">(</span><span class="hl-2">"muffin"</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">editEntrySafe</span><span class="hl-1">(</span><span class="hl-2">"1gOtzWvrdq"</span><span class="hl-1">, { </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">"test"</span><span class="hl-1">, </span><span class="hl-4">_modified:</span><span class="hl-1"> </span><span class="hl-2">"2020-01-01T00:00:00.000Z"</span><span class="hl-1">})</span>
|
|
114
|
-
</code><button type="button">Copy</button></pre>
|
|
115
|
-
|
|
116
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L124">api.ts:124</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="entries" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>entries</span><a href="#entries" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="entries-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">entries</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <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><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#entries-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads entry list. Expects <code>dmShortID</code> / <code>model</code> to be set.
|
|
117
|
-
If the model is not public, you also need to provide a <code>token</code>.</p>
|
|
118
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>options for entry list request.</p>
|
|
119
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-10" class="tsd-anchor"></a>Example<a href="#example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">// public model</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">muffins</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">model</span><span class="hl-1">(</span><span class="hl-2">"muffin"</span><span class="hl-1">).</span><span class="hl-0">entries</span><span class="hl-1">()</span>
|
|
120
|
-
</code><button type="button">Copy</button></pre>
|
|
121
|
-
|
|
122
|
-
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-11" class="tsd-anchor"></a>Example<a href="#example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">// non-public model</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">secrets</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">token</span><span class="hl-1">(</span><span class="hl-4">token</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">model</span><span class="hl-1">(</span><span class="hl-2">"secret"</span><span class="hl-1">).</span><span class="hl-0">entries</span><span class="hl-1">()</span>
|
|
123
|
-
</code><button type="button">Copy</button></pre>
|
|
124
|
-
|
|
125
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L74">api.ts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="entrylist" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>entry<wbr/>List</span><a href="#entrylist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="entrylist-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">entryList</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#entrylist-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L78">api.ts:78</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getasset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Asset</span><a href="#getasset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getasset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAsset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">assetID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getasset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads a single asset. Expects <code>dmShortID</code> / <code>assetGroup</code> to be set.
|
|
126
|
-
If the asset group is not public, you also need to provide a <code>token</code>.</p>
|
|
127
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assetID</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-12" class="tsd-anchor"></a>Example<a href="#example-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">asset</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">assetgroup</span><span class="hl-1">(</span><span class="hl-2">"test"</span><span class="hl-1">).</span><span class="hl-0">getAsset</span><span class="hl-1">(</span><span class="hl-2">"tP-ZxpZZTGmbPnET-wArAQ"</span><span class="hl-1">)</span>
|
|
128
|
-
</code><button type="button">Copy</button></pre>
|
|
129
|
-
|
|
130
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L206">api.ts:206</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getauth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Auth</span><a href="#getauth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getauth-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAuth</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getauth-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L307">api.ts:307</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getbesttoken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Best<wbr/>Token</span><a href="#getbesttoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getbesttoken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getBestToken</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getbesttoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L356">api.ts:356</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getdatamanager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Datamanager</span><a href="#getdatamanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getdatamanager-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getDatamanager</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dmID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getdatamanager-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads a DatamanagerResource by its long id. Requires token.</p>
|
|
131
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dmID</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>any</p>
|
|
132
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L456">api.ts:456</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getectoken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Ec<wbr/>Token</span><a href="#getectoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getectoken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getEcToken</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getectoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L344">api.ts:344</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getentry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Entry</span><a href="#getentry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getentry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getEntry</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entryID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getentry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads a single entry. Expects <code>dmShortID</code> / <code>model</code> to be set.
|
|
133
|
-
If the model is not public, you also need to provide a <code>token</code>.</p>
|
|
134
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entryID</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-13" class="tsd-anchor"></a>Example<a href="#example-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">muffin</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">model</span><span class="hl-1">(</span><span class="hl-2">"muffin"</span><span class="hl-1">).</span><span class="hl-0">getEntry</span><span class="hl-1">(</span><span class="hl-2">"1gOtzWvrdq"</span><span class="hl-1">)</span>
|
|
135
|
-
</code><button type="button">Copy</button></pre>
|
|
136
|
-
|
|
137
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L106">api.ts:106</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getpublictoken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Public<wbr/>Token</span><a href="#getpublictoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getpublictoken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getPublicToken</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getpublictoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L341">api.ts:341</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getschema" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Schema</span><a href="#getschema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getschema-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSchema</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><a href="#getschema-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads the schema of a model. Expects <code>dmShortID</code> / <code>model</code> to be set.</p>
|
|
138
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-14" class="tsd-anchor"></a>Example<a href="#example-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">muffin</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">model</span><span class="hl-1">(</span><span class="hl-2">"muffin"</span><span class="hl-1">).</span><span class="hl-0">getSchema</span><span class="hl-1">()</span>
|
|
139
|
-
</code><button type="button">Copy</button></pre>
|
|
140
|
-
|
|
141
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L136">api.ts:136</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hasanytoken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Any<wbr/>Token</span><a href="#hasanytoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="hasanytoken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hasAnyToken</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hasanytoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L353">api.ts:353</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hasectoken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Ec<wbr/>Token</span><a href="#hasectoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="hasectoken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hasEcToken</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hasectoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L350">api.ts:350</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="haspublictoken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Public<wbr/>Token</span><a href="#haspublictoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="haspublictoken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hasPublicToken</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#haspublictoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L347">api.ts:347</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loginec" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>login<wbr/>Ec</span><a href="#loginec" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loginec-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">loginEc</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#loginec-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L315">api.ts:315</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loginpublic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>login<wbr/>Public</span><a href="#loginpublic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="loginpublic-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">loginPublic</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#loginpublic-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L320">api.ts:320</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="logoutec" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>logout<wbr/>Ec</span><a href="#logoutec" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="logoutec-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">logoutEc</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#logoutec-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L334">api.ts:334</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="logoutpublic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>logout<wbr/>Public</span><a href="#logoutpublic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="logoutpublic-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">logoutPublic</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#logoutpublic-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L327">api.ts:327</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="mapentries" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>map<wbr/>Entries</span><a href="#mapentries" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mapentries-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mapEntries</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#mapentries-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Maps over entry list.</p>
|
|
142
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>options for entry list request.</p>
|
|
143
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-15" class="tsd-anchor"></a>Example<a href="#example-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">// public model</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">muffins</span><span class="hl-1"> = </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dm</span><span class="hl-1">(</span><span class="hl-2">"83cc6374"</span><span class="hl-1">).</span><span class="hl-0">model</span><span class="hl-1">(</span><span class="hl-2">"muffin"</span><span class="hl-1">)</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">muffin</span><span class="hl-1">.</span><span class="hl-0">mapEntries</span><span class="hl-1">((</span><span class="hl-4">entry</span><span class="hl-1">) </span><span class="hl-6">=></span><span class="hl-1"> </span><span class="hl-4">muffin</span><span class="hl-1">.</span><span class="hl-0">editEntry</span><span class="hl-1">(</span><span class="hl-4">entry</span><span class="hl-1">.</span><span class="hl-4">id</span><span class="hl-1">, { </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-4">entry</span><span class="hl-1">.</span><span class="hl-4">name</span><span class="hl-1"> + </span><span class="hl-2">"!"</span><span class="hl-1"> }));</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">"res"</span><span class="hl-1">, </span><span class="hl-4">res</span><span class="hl-1">);</span>
|
|
144
|
-
</code><button type="button">Copy</button></pre>
|
|
145
|
-
|
|
146
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L93">api.ts:93</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="model" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="model-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">model</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#model-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the given model to use</p>
|
|
147
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">model</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>name of the model</p>
|
|
148
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
149
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L368">api.ts:368</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="modellist" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>model<wbr/>List</span><a href="#modellist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="modellist-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">modelList</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <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><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#modellist-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Loads model list. Expects dmID to be set. Make sure to provide an ec.admin <code>token</code> intercept one.</p>
|
|
150
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>options for entry list request.</p>
|
|
151
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-16" class="tsd-anchor"></a>Example<a href="#example-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">models</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">dmID</span><span class="hl-1">(</span><span class="hl-2">"254a03f1-cb76-4f1e-a52a-bbd4180ca10c"</span><span class="hl-1">).</span><span class="hl-0">modelList</span><span class="hl-1">()</span>
|
|
152
|
-
</code><button type="button">Copy</button></pre>
|
|
153
|
-
|
|
154
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L481">api.ts:481</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="publicapi" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>public<wbr/>Api</span><a href="#publicapi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="publicapi-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">publicApi</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#publicapi-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the public api root endpoint. Expects dmShortID to be set.</p>
|
|
155
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>any</p>
|
|
156
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L448">api.ts:448</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="raw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>raw</span><a href="#raw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="raw-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">raw</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fetchOptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#raw-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches raw route. Expects <code>route</code> to be set. <code>subdomain</code> defaults to "datamanager".
|
|
157
|
-
Fetches <code>https://<subdomain>.entrecode.de/<route>?<options></code>
|
|
158
|
-
Use this when no other fdk method can give you your request.</p>
|
|
159
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>options for list request.</p>
|
|
160
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fetchOptions</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>(optional) options passed to fetch.</p>
|
|
161
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-17" class="tsd-anchor"></a>Example<a href="#example-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">route</span><span class="hl-1">(</span><span class="hl-2">"stats"</span><span class="hl-1">).</span><span class="hl-0">raw</span><span class="hl-1">()</span>
|
|
162
|
-
</code><button type="button">Copy</button></pre>
|
|
163
|
-
|
|
164
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L277">api.ts:277</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>resource</span><a href="#resource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="resource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">resource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#resource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the name of the resource to use.</p>
|
|
165
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">resource</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>name of the resource</p>
|
|
166
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
167
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L432">api.ts:432</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resourcelist" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>resource<wbr/>List</span><a href="#resourcelist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="resourcelist-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">resourceList</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#resourcelist-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetches resource list. Expects <code>resource</code> to be set. <code>subdomain</code> defaults to "datamanager".
|
|
168
|
-
Fetches <code>https://<subdomain>.entrecode.de/<resource>?_list=true&size=<options.size ?? 25></code></p>
|
|
169
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>options for list request.</p>
|
|
170
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-18" class="tsd-anchor"></a>Example<a href="#example-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">sdk</span><span class="hl-1">(</span><span class="hl-2">"stage"</span><span class="hl-1">).</span><span class="hl-0">resource</span><span class="hl-1">(</span><span class="hl-2">"template"</span><span class="hl-1">).</span><span class="hl-0">resourceList</span><span class="hl-1">()</span>
|
|
171
|
-
</code><button type="button">Copy</button></pre>
|
|
172
|
-
|
|
173
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L261">api.ts:261</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="route" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>route</span><a href="#route" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="route-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">route</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">route</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#route-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the route to use.</p>
|
|
174
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">route</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>route</p>
|
|
175
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
176
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L440">api.ts:440</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="set" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="set-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L56">api.ts:56</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setauth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Auth</span><a href="#setauth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setauth-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setAuth</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">auth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span><a href="#setauth-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">auth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L287">api.ts:287</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="storageadapter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>storage<wbr/>Adapter</span><a href="#storageadapter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="storageadapter-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">storageAdapter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">storageAdapter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#storageadapter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">storageAdapter</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L282">api.ts:282</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="subdomain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subdomain</span><a href="#subdomain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="subdomain-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subdomain</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subdomain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#subdomain-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the subdomain to use.</p>
|
|
177
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">subdomain</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>subdomain</p>
|
|
178
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
179
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L424">api.ts:424</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="token" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>token</span><a href="#token" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="token-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">token</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a><a href="#token-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the token to use in requests</p>
|
|
180
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Sdk.html" class="tsd-signature-type tsd-kind-class">Sdk</a></h4><p>Sdk</p>
|
|
181
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L376">api.ts:376</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unsetauth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unset<wbr/>Auth</span><a href="#unsetauth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unsetauth-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unsetAuth</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">auth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span><a href="#unsetauth-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">auth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/entrecode/ec.fdk/blob/10da8df0c4055026d1407b3eba4eb450fcc48915/packages/ec.fdk/src/lib/api.ts#L297">api.ts:297</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#config" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#assetgroup" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assetgroup</span></a><a href="#assetgroup-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>asset<wbr/>Group</span></a><a href="#assetlist" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>asset<wbr/>List</span></a><a href="#assets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assets</span></a><a href="#createasset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Asset</span></a><a href="#createentry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Entry</span></a><a href="#deleteasset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Asset</span></a><a href="#deleteentry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Entry</span></a><a href="#dm" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dm</span></a><a href="#dmid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dmID</span></a><a href="#dmlist" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dm<wbr/>List</span></a><a href="#dmshortid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dm<wbr/>ShortID</span></a><a href="#editentry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Entry</span></a><a href="#editentrysafe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Entry<wbr/>Safe</span></a><a href="#entries" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>entries</span></a><a href="#entrylist" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>entry<wbr/>List</span></a><a href="#getasset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Asset</span></a><a href="#getauth" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Auth</span></a><a href="#getbesttoken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Best<wbr/>Token</span></a><a href="#getdatamanager" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Datamanager</span></a><a href="#getectoken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Ec<wbr/>Token</span></a><a href="#getentry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Entry</span></a><a href="#getpublictoken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Public<wbr/>Token</span></a><a href="#getschema" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Schema</span></a><a href="#hasanytoken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Any<wbr/>Token</span></a><a href="#hasectoken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Ec<wbr/>Token</span></a><a href="#haspublictoken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Public<wbr/>Token</span></a><a href="#loginec" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>login<wbr/>Ec</span></a><a href="#loginpublic" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>login<wbr/>Public</span></a><a href="#logoutec" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>logout<wbr/>Ec</span></a><a href="#logoutpublic" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>logout<wbr/>Public</span></a><a href="#mapentries" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>map<wbr/>Entries</span></a><a href="#model" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>model</span></a><a href="#modellist" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>model<wbr/>List</span></a><a href="#publicapi" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>public<wbr/>Api</span></a><a href="#raw" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>raw</span></a><a href="#resource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resource</span></a><a href="#resourcelist" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resource<wbr/>List</span></a><a href="#route" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>route</span></a><a href="#set" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#setauth" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Auth</span></a><a href="#storageadapter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>storage<wbr/>Adapter</span></a><a href="#subdomain" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subdomain</span></a><a href="#token" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>token</span></a><a href="#unsetauth" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unset<wbr/>Auth</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ec.fdk</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|