atlas-app-services-admin-api

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FunctionsApiFp | atlas-app-services-admin-api</title><meta name="description" content="Documentation for atlas-app-services-admin-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></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"</script><header class="tsd-page-toolbar"> <div class="tsd-toolbar-contents container"> <div class="table-cell" id="tsd-search" data-base=".."> <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="#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">atlas-app-services-admin-api</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="#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="../index.html">atlas-app-services-admin-api</a></li> <li><a href="../modules/api.html">api</a></li> <li><a href="api.FunctionsApiFp.html">FunctionsApiFp</a></li></ul> <h1>Function FunctionsApiFp</h1></div> <section class="tsd-panel"> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="FunctionsApiFp"><span class="tsd-kind-call-signature">Functions<wbr/>Api<wbr/>Fp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</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><br/><span> </span><span class="tsd-kind-call-signature">adminCreateFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">newFunction</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminCreateFunction201Response.html" class="tsd-signature-type tsd-kind-interface">AdminCreateFunction201Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminDeleteFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">functionId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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><br/><span> </span><span class="tsd-kind-call-signature">adminExecuteFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</span>, <span class="tsd-kind-parameter">runAsSystem</span>, <span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">adminExecuteFunctionRequest</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminExecuteFunction200Response.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunction200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminExecuteFunctionSource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</span>, <span class="tsd-kind-parameter">runAsSystem</span>, <span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">adminExecuteFunctionSourceRequest</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminExecuteFunction200Response.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunction200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">functionId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.Function.html" class="tsd-signature-type tsd-kind-interface">Function</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminListFunctions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</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-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminUpdateFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">functionId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.NewFunction.html" class="tsd-signature-type tsd-kind-interface">NewFunction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#FunctionsApiFp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>FunctionsApi - functional programming interface</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></h5></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">adminCreateFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">newFunction</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminCreateFunction201Response.html" class="tsd-signature-type tsd-kind-interface">AdminCreateFunction201Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminDeleteFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">functionId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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><br/><span> </span><span class="tsd-kind-call-signature">adminExecuteFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</span>, <span class="tsd-kind-parameter">runAsSystem</span>, <span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">adminExecuteFunctionRequest</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminExecuteFunction200Response.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunction200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminExecuteFunctionSource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</span>, <span class="tsd-kind-parameter">runAsSystem</span>, <span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">adminExecuteFunctionSourceRequest</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminExecuteFunction200Response.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunction200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">functionId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.Function.html" class="tsd-signature-type tsd-kind-interface">Function</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminListFunctions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</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-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminUpdateFunction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">functionId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.NewFunction.html" class="tsd-signature-type tsd-kind-interface">NewFunction</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Create<wbr/>Function</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="FunctionsApiFp.__type.adminCreateFunction.adminCreateFunction-1"><span class="tsd-kind-call-signature">admin<wbr/>Create<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">newFunction</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminCreateFunction201Response.html" class="tsd-signature-type tsd-kind-interface">AdminCreateFunction201Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#FunctionsApiFp.__type.adminCreateFunction.adminCreateFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Create a new <a href="https://www.mongodb.com/docs/realm/functions#std-label-functions">Function</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">newFunction</span>: <a href="../interfaces/api.NewFunction.html" class="tsd-signature-type tsd-kind-interface">NewFunction</a></h5> <div class="tsd-comment tsd-typography"><p>The function to create</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </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-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminCreateFunction201Response.html" class="tsd-signature-type tsd-kind-interface">AdminCreateFunction201Response</a><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"> <h4>Summary</h4><p>Create a new Function</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L10784">src/api.ts:10784</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Delete<wbr/>Function</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="FunctionsApiFp.__type.adminDeleteFunction.adminDeleteFunction-1"><span class="tsd-kind-call-signature">admin<wbr/>Delete<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">functionId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#FunctionsApiFp.__type.adminDeleteFunction.adminDeleteFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Delete a <a href="https://www.mongodb.com/docs/realm/functions#std-label-functions">Function</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">functionId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a function.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </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-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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"> <h4>Summary</h4><p>Delete a Function</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L10797">src/api.ts:10797</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Execute<wbr/>Function</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="FunctionsApiFp.__type.adminExecuteFunction.adminExecuteFunction-1"><span class="tsd-kind-call-signature">admin<wbr/>Execute<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</span>, <span class="tsd-kind-parameter">runAsSystem</span>, <span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">adminExecuteFunctionRequest</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminExecuteFunction200Response.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunction200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#FunctionsApiFp.__type.adminExecuteFunction.adminExecuteFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Execute a <a href="https://www.mongodb.com/docs/realm/functions#std-label-functions">function</a> for testing.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">userId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The user as which to execute the function. Either `user_id` or `run_as_system` is required. You cannot specify both.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">runAsSystem</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Determine whether or not to run as system user. Either `run_as_system` or `user_id` is required. You cannot specify both.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">adminExecuteFunctionRequest</span>: <a href="../interfaces/api.AdminExecuteFunctionRequest.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunctionRequest</a></h5> <div class="tsd-comment tsd-typography"><p>The function to execute.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </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-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminExecuteFunction200Response.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunction200Response</a><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"> <h4>Summary</h4><p>Execute a function</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L10812">src/api.ts:10812</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Execute<wbr/>Function<wbr/>Source</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="FunctionsApiFp.__type.adminExecuteFunctionSource.adminExecuteFunctionSource-1"><span class="tsd-kind-call-signature">admin<wbr/>Execute<wbr/>Function<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</span>, <span class="tsd-kind-parameter">runAsSystem</span>, <span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">adminExecuteFunctionSourceRequest</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminExecuteFunction200Response.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunction200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#FunctionsApiFp.__type.adminExecuteFunctionSource.adminExecuteFunctionSource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Execute a <a href="https://www.mongodb.com/docs/realm/functions#std-label-functions">function</a>'s source code for testing.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">userId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The user as which to execute the function. Either `user_id` or `run_as_system` is required. You cannot specify both.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">runAsSystem</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Determine whether or not to run as system user. Either `run_as_system` or `user_id` is required. You cannot specify both.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">adminExecuteFunctionSourceRequest</span>: <a href="../interfaces/api.AdminExecuteFunctionSourceRequest.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunctionSourceRequest</a></h5> <div class="tsd-comment tsd-typography"><p>The source to execute.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </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-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminExecuteFunction200Response.html" class="tsd-signature-type tsd-kind-interface">AdminExecuteFunction200Response</a><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"> <h4>Summary</h4><p>Execute a function's source code for testing</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L10827">src/api.ts:10827</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Get<wbr/>Function</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="FunctionsApiFp.__type.adminGetFunction.adminGetFunction-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">functionId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.Function.html" class="tsd-signature-type tsd-kind-interface">Function</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><a href="#FunctionsApiFp.__type.adminGetFunction.adminGetFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Retrieve a <a href="https://www.mongodb.com/docs/realm/functions#std-label-functions">Function</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">functionId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a function.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </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-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.Function.html" class="tsd-signature-type tsd-kind-interface">Function</a><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"> <h4>Summary</h4><p>Retrieve a Function</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L10840">src/api.ts:10840</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>List<wbr/>Functions</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="FunctionsApiFp.__type.adminListFunctions.adminListFunctions-1"><span class="tsd-kind-call-signature">admin<wbr/>List<wbr/>Functions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</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><a href="#FunctionsApiFp.__type.adminListFunctions.adminListFunctions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>List <a href="https://www.mongodb.com/docs/realm/functions#std-label-functions">Functions</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd