UNPKG

atlas-app-services-admin-api

Version:
474 lines (464 loc) 63 kB
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GraphqlApiInterface | 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.GraphqlApiInterface.html">GraphqlApiInterface</a></li></ul> <h1>Interface GraphqlApiInterface</h1></div> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"><p>GraphqlApi - interface</p> </div> <div class="tsd-comment tsd-typography"> <h4>Export</h4><p>GraphqlApi</p> </div></section> <section class="tsd-panel tsd-hierarchy"> <h4>Hierarchy</h4> <ul class="tsd-hierarchy"> <li><span class="target">GraphqlApiInterface</span></li></ul></section> <section class="tsd-panel"> <h4>Implemented by</h4> <ul class="tsd-hierarchy"> <li><a href="../classes/api.GraphqlApi.html" class="tsd-signature-type tsd-kind-class">GraphqlApi</a></li></ul></section><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L11915">src/api.ts:11915</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-index-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="#icon-chevronSmall"></use></svg> Index</h5></summary> <div class="tsd-accordion-details"> <section class="tsd-index-section"> <h3 class="tsd-index-heading">Methods</h3> <div class="tsd-index-list"><a href="api.GraphqlApiInterface.html#adminCreateCustomResolver" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Create<wbr/>Custom<wbr/>Resolver</span></a> <a href="api.GraphqlApiInterface.html#adminDeleteCustomResolver" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Delete<wbr/>Custom<wbr/>Resolver</span></a> <a href="api.GraphqlApiInterface.html#adminGetAllCustomResolvers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>All<wbr/>Custom<wbr/>Resolvers</span></a> <a href="api.GraphqlApiInterface.html#adminGetCustomResolver" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>Custom<wbr/>Resolver</span></a> <a href="api.GraphqlApiInterface.html#adminGetGraphQLConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>GraphQLConfig</span></a> <a href="api.GraphqlApiInterface.html#adminGetGraphQLValidationSettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>GraphQLValidation<wbr/>Settings</span></a> <a href="api.GraphqlApiInterface.html#adminModifyCustomResolver" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Modify<wbr/>Custom<wbr/>Resolver</span></a> <a href="api.GraphqlApiInterface.html#adminRunGraphQLOperation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Run<wbr/>GraphQLOperation</span></a> <a href="api.GraphqlApiInterface.html#adminSetGraphQLValidationSettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Set<wbr/>GraphQLValidation<wbr/>Settings</span></a> <a href="api.GraphqlApiInterface.html#adminUpdateGraphQLConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Update<wbr/>GraphQLConfig</span></a> </div></section></div></details></section></section> <section class="tsd-panel-group tsd-member-group"> <h2>Methods</h2> <section class="tsd-panel tsd-member"><a id="adminCreateCustomResolver" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Create<wbr/>Custom<wbr/>Resolver</span><a href="#adminCreateCustomResolver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminCreateCustomResolver.adminCreateCustomResolver-1"><span class="tsd-kind-call-signature">admin<wbr/>Create<wbr/>Custom<wbr/>Resolver</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">customResolver</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">&gt;</span><a href="#adminCreateCustomResolver.adminCreateCustomResolver-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/graphql/custom-resolvers/">custom resolver</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">customResolver</span>: <a href="api.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a></h5> <div class="tsd-comment tsd-typography"><p>A valid <a href="https://www.mongodb.com/docs/atlas/app-services/reference/config/graphql#std-label-appconfig-custom-resolver">custom resolver configuration</a> object.</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Create a custom resolver</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L11926">src/api.ts:11926</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminDeleteCustomResolver" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Delete<wbr/>Custom<wbr/>Resolver</span><a href="#adminDeleteCustomResolver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminDeleteCustomResolver.adminDeleteCustomResolver-1"><span class="tsd-kind-call-signature">admin<wbr/>Delete<wbr/>Custom<wbr/>Resolver</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">customResolverId</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#adminDeleteCustomResolver.adminDeleteCustomResolver-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 an existing <a href="https://www.mongodb.com/docs/realm/graphql/custom-resolvers/">custom resolver</a> configuration.</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">customResolverId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique &#x60;_id&#x60; value of a custom resolver.</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Delete a custom resolver</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L11938">src/api.ts:11938</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminGetAllCustomResolvers" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Get<wbr/>All<wbr/>Custom<wbr/>Resolvers</span><a href="#adminGetAllCustomResolvers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminGetAllCustomResolvers.adminGetAllCustomResolvers-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>All<wbr/>Custom<wbr/>Resolvers</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#adminGetAllCustomResolvers.adminGetAllCustomResolvers-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>Get all <a href="https://www.mongodb.com/docs/realm/graphql/custom-resolvers/">custom resolver</a> configurations from your app&#39;s GraphQL API.</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get all custom resolvers</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L11949">src/api.ts:11949</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminGetCustomResolver" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Get<wbr/>Custom<wbr/>Resolver</span><a href="#adminGetCustomResolver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminGetCustomResolver.adminGetCustomResolver-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Custom<wbr/>Resolver</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">customResolverId</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">&gt;</span><a href="#adminGetCustomResolver.adminGetCustomResolver-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>Get a specific <a href="https://www.mongodb.com/docs/realm/graphql/custom-resolvers/">custom resolver</a> configuration.</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">customResolverId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique &#x60;_id&#x60; value of a custom resolver.</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get a custom resolver</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L11961">src/api.ts:11961</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminGetGraphQLConfig" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Get<wbr/>GraphQLConfig</span><a href="#adminGetGraphQLConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminGetGraphQLConfig.adminGetGraphQLConfig-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>GraphQLConfig</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.GraphQLConfig.html" class="tsd-signature-type tsd-kind-interface">GraphQLConfig</a><span class="tsd-signature-symbol">&gt;</span><a href="#adminGetGraphQLConfig.adminGetGraphQLConfig-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>Get your app&#39;s <a href="https://www.mongodb.com/docs/atlas/app-services/graphql/">GraphQL API</a> configuration.</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.GraphQLConfig.html" class="tsd-signature-type tsd-kind-interface">GraphQLConfig</a><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get GraphQL API Configuration</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L11972">src/api.ts:11972</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminGetGraphQLValidationSettings" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Get<wbr/>GraphQLValidation<wbr/>Settings</span><a href="#adminGetGraphQLValidationSettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminGetGraphQLValidationSettings.adminGetGraphQLValidationSettings-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>GraphQLValidation<wbr/>Settings</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.GraphQLValidationSettings.html" class="tsd-signature-type tsd-kind-interface">GraphQLValidationSettings</a><span class="tsd-signature-symbol">&gt;</span><a href="#adminGetGraphQLValidationSettings.adminGetGraphQLValidationSettings-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>Get the current validation level and action for reads and writes.</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.GraphQLValidationSettings.html" class="tsd-signature-type tsd-kind-interface">GraphQLValidationSettings</a><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get validation settings</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L11983">src/api.ts:11983</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminModifyCustomResolver" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Modify<wbr/>Custom<wbr/>Resolver</span><a href="#adminModifyCustomResolver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminModifyCustomResolver.adminModifyCustomResolver-1"><span class="tsd-kind-call-signature">admin<wbr/>Modify<wbr/>Custom<wbr/>Resolver</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">customResolverId</span>, <span class="tsd-kind-parameter">customResolver</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#adminModifyCustomResolver.adminModifyCustomResolver-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>Modify an existing <a href="https://www.mongodb.com/docs/realm/graphql/custom-resolvers/">custom resolver</a> configuration.</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">customResolverId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique &#x60;_id&#x60; value of a custom resolver.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">customResolver</span>: <a href="api.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a></h5> <div class="tsd-comment tsd-typography"><p>A valid, updated <a href="https://www.mongodb.com/docs/atlas/app-services/reference/config/graphql#std-label-appconfig-custom-resolver">custom resolver configuration</a> object.</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Modify a custom resolver</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L11996">src/api.ts:11996</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminRunGraphQLOperation" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Run<wbr/>GraphQLOperation</span><a href="#adminRunGraphQLOperation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminRunGraphQLOperation.adminRunGraphQLOperation-1"><span class="tsd-kind-call-signature">admin<wbr/>Run<wbr/>GraphQLOperation</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">adminRunGraphQLOperationRequest</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-type ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.AdminRunGraphQLOperation200Response.html" class="tsd-signature-type tsd-kind-interface">AdminRunGraphQLOperation200Response</a><span class="tsd-signature-symbol">&gt;</span><a href="#adminRunGraphQLOperation.adminRunGraphQLOperation-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>Run a query or mutation as a system user that bypasses authentication and data access rules. You can access metadata about your API, including its schema, with an <a href="https://graphql.org/learn/introspection/">introspection</a> query.</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">adminRunGraphQLOperationRequest</span>: <a href="api.AdminRunGraphQLOperationRequest.html" class="tsd-signature-type tsd-kind-interface">AdminRunGraphQLOperationRequest</a></h5> <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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><a href="api.AdminRunGraphQLOperation200Response.html" class="tsd-signature-type tsd-kind-interface">AdminRunGraphQLOperation200Response</a><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Run a query or mutation</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L12008">src/api.ts:12008</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminSetGraphQLValidationSettings" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Set<wbr/>GraphQLValidation<wbr/>Settings</span><a href="#adminSetGraphQLValidationSettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminSetGraphQLValidationSettings.adminSetGraphQLValidationSettings-1"><span class="tsd-kind-call-signature">admin<wbr/>Set<wbr/>GraphQLValidation<wbr/>Settings</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">graphQLValidationSettings</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#adminSetGraphQLValidationSettings.adminSetGraphQLValidationSettings-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>Set the validation level and action for reads and writes.</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">graphQLValidationSettings</span>: <a href="api.GraphQLValidationSettings.html" class="tsd-signature-type tsd-kind-interface">GraphQLValidationSettings</a></h5> <div class="tsd-comment tsd-typography"><p>The updated validation levels and actions.</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Modify validation settings</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L12020">src/api.ts:12020</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminUpdateGraphQLConfig" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Update<wbr/>GraphQLConfig</span><a href="#adminUpdateGraphQLConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminUpdateGraphQLConfig.adminUpdateGraphQLConfig-1"><span class="tsd-kind-call-signature">admin<wbr/>Update<wbr/>GraphQLConfig</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">graphQLConfig</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#adminUpdateGraphQLConfig.adminUpdateGraphQLConfig-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>Update your app&#39;s <a href="https://www.mongodb.com/docs/atlas/app-services/graphql/">GraphQL API</a> configuration.</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">graphQLConfig</span>: <a href="api.GraphQLConfig.html" class="tsd-signature-type tsd-kind-interface">GraphQLConfig</a></h5> <div class="tsd-comment tsd-typography"><p>A valid <a href="https://www.mongodb.com/docs/atlas/app-services/reference/config/graphql#std-label-appconfig-graphql">GraphQL API configuration object</a>.</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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 ">AxiosPromise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Update GraphQL API Configuration</p> <h4>Throws</h4> <h4>Memberof</h4><p>GraphqlApiInterface</p> </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#L12032">src/api.ts:12032</a></li></ul></aside></li></ul></section></section></div> <div class="col-sidebar"> <div class="page-menu"> <div class="tsd-navigation settings"> <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary> <div class="tsd-accordion-details"> <div class="tsd-filter-visibility"> <h4 class="uppercase">Member Visibility</h4><form> <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-private" name="private"/><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>Private</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></form></div> <div class="tsd-theme-toggle"> <h4 class="uppercase">Theme</h4><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-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary> <div class="tsd-accordion-details"> <ul> <li><a href="#adminCreateCustomResolver" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Create<wbr/>Custom<wbr/>Resolver</span></a></li> <li><a href="#adminDeleteCustomResolver" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Delete<wbr/>Custom<wbr/>Resolver</span></a></li> <li><a href="#adminGetAllCustomResolvers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>All<wbr/>Custom<wbr/>Resolvers</span></a></li> <li><a href="#adminGetCustomResolver" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>Custom<wbr/>Resolver</span></a></li> <li><a href="#adminGetGraphQLConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>GraphQLConfig</span></a></li> <li><a href="#adminGetGraphQLValidationSettings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>GraphQLValidation<wbr/>Settings</span></a></li> <li><a href="#adminModifyCustomResolver" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Modify<wbr/>Custom<wbr/>Resolver</span></a></li> <li><a href="#adminRunGraphQLOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Run<wbr/>GraphQLOperation</span></a></li> <li><a href="#adminSetGraphQLValidationSettings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Set<wbr/>GraphQLValidation<wbr/>Settings</span></a></li> <li><a href="#adminUpdateGraphQLConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Update<wbr/>GraphQLConfig</span></a></li></ul></div></details></div> <div class="site-menu"> <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>atlas-app-services-admin-api</span></a> <ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."> <li><a href="../modules/api.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>api</a></li> <li><a href="../modules/base.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>base</a></li> <li><a href="../modules/client.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>client</a></li> <li><a href="../modules/client_spec.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>client.spec</a></li> <li><a href="../modules/common.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>common</a></li> <li><a href="../modules/configuration.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>configuration</a></li> <li><a href="../modules/index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>index</a></li></ul></nav></div></div></div> <div class="tsd-generator"> <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div> <div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-name