mirror of
https://github.com/classchartsapi/classcharts-api-js.git
synced 2026-05-14 11:58:13 +00:00
44 lines
No EOL
48 KiB
HTML
44 lines
No EOL
48 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ClasschartsParentClient | classcharts-api</title><meta name="description" content="Documentation for classcharts-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">classcharts-api</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">classcharts-api</a></li><li><a href="../modules/parent.html">parent</a></li><li><a href="parent.ClasschartsParentClient.html">ClasschartsParentClient</a></li></ul><h1>Class ClasschartsParentClient</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The base client</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="client.ClasschartsClient.html" class="tsd-signature-type" data-tsd-kind="Class">ClasschartsClient</a><ul class="tsd-hierarchy"><li><span class="target">ClasschartsParentClient</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="parent.ClasschartsParentClient.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#API_BASE" class="tsd-kind-icon">API_<wbr/>BASE</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#authCookies" class="tsd-kind-icon">auth<wbr/>Cookies</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="parent.ClasschartsParentClient.html#email" class="tsd-kind-icon">email</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="parent.ClasschartsParentClient.html#password" class="tsd-kind-icon">password</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#sessionId" class="tsd-kind-icon">session<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#studentId" class="tsd-kind-icon">student<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#studentName" class="tsd-kind-icon">student<wbr/>Name</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getActivity" class="tsd-kind-icon">get<wbr/>Activity</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getBadges" class="tsd-kind-icon">get<wbr/>Badges</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getBehaviour" class="tsd-kind-icon">get<wbr/>Behaviour</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getDetentions" class="tsd-kind-icon">get<wbr/>Detentions</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getLessons" class="tsd-kind-icon">get<wbr/>Lessons</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="parent.ClasschartsParentClient.html#getPupils" class="tsd-kind-icon">get<wbr/>Pupils</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getStudentInfo" class="tsd-kind-icon">get<wbr/>Student<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#listAnnouncements" class="tsd-kind-icon">list<wbr/>Announcements</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#listHomeworks" class="tsd-kind-icon">list<wbr/>Homeworks</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="parent.ClasschartsParentClient.html#login" class="tsd-kind-icon">login</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#makeAuthedRequest" class="tsd-kind-icon">make<wbr/>Authed<wbr/>Request</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Classcharts<wbr/>Parent<wbr/>Client<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="parent.ClasschartsParentClient.html" class="tsd-signature-type" data-tsd-kind="Class">ClasschartsParentClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/parent.ts#L32">parent.ts:32</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>email: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Parents email address</p>
|
|
</div></div></li><li><h5>password: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Parents password</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="parent.ClasschartsParentClient.html" class="tsd-signature-type" data-tsd-kind="Class">ClasschartsParentClient</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a id="API_BASE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> API_<wbr/>BASE<a href="#API_BASE" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">API_<wbr/>BASE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#API_BASE">API_BASE</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L27">client.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a id="authCookies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> auth<wbr/>Cookies<a href="#authCookies" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">auth<wbr/>Cookies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#authCookies">authCookies</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L25">client.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="email" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> email<a href="#email" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">email<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/parent.ts#L26">parent.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="password" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> password<a href="#password" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">password<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/parent.ts#L25">parent.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a id="sessionId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> session<wbr/>Id<a href="#sessionId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">session<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#sessionId">sessionId</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L26">client.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a id="studentId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> student<wbr/>Id<a href="#studentId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">student<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#studentId">studentId</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L23">client.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a id="studentName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagProtected">Protected</span> student<wbr/>Name<a href="#studentName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">student<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#studentName">studentName</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L24">client.ts:24</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getActivity" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Activity<a href="#getActivity" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Activity<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.GetActivityOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetActivityOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#ActivityResponse" class="tsd-signature-type" data-tsd-kind="Type alias">ActivityResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#getActivity">getActivity</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L84">client.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Get's the logged in student's general activity</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/types.GetActivityOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetActivityOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GetActivityOptions</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#ActivityResponse" class="tsd-signature-type" data-tsd-kind="Type alias">ActivityResponse</a><span class="tsd-signature-symbol">></span></h4><div><p>Activity data</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getBadges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Badges<a href="#getBadges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Badges<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#BadgesResponse" class="tsd-signature-type" data-tsd-kind="Type alias">BadgesResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#getBadges">getBadges</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L169">client.ts:169</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Gets a list of the students badges</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#BadgesResponse" class="tsd-signature-type" data-tsd-kind="Type alias">BadgesResponse</a><span class="tsd-signature-symbol">></span></h4><div><p>Array of badges</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getBehaviour" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Behaviour<a href="#getBehaviour" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Behaviour<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.GetBehaviourOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetBehaviourOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.BehaviourResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BehaviourResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#getBehaviour">getBehaviour</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L104">client.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Gets the logged in students behaviour points</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/types.GetBehaviourOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetBehaviourOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GetBehaviourOptions</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.BehaviourResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BehaviourResponse</a><span class="tsd-signature-symbol">></span></h4><div><p>Array of behaviour points</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getDetentions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Detentions<a href="#getDetentions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Detentions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#DetentionsResponse" class="tsd-signature-type" data-tsd-kind="Type alias">DetentionsResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#getDetentions">getDetentions</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L193">client.ts:193</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Gets the logged in student's detentions</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#DetentionsResponse" class="tsd-signature-type" data-tsd-kind="Type alias">DetentionsResponse</a><span class="tsd-signature-symbol">></span></h4><div><p>Array of detentions</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getLessons" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Lessons<a href="#getLessons" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Lessons<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.GetLessonsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetLessonsOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#LessonsResponse" class="tsd-signature-type" data-tsd-kind="Type alias">LessonsResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#getLessons">getLessons</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L154">client.ts:154</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Gets the logged in student's lessons for a day</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/types.GetLessonsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetLessonsOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GetLessonsOptions</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#LessonsResponse" class="tsd-signature-type" data-tsd-kind="Type alias">LessonsResponse</a><span class="tsd-signature-symbol">></span></h4><div><p>Array of lessons</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPupils" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Pupils<a href="#getPupils" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Pupils<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#ActivityResponse" class="tsd-signature-type" data-tsd-kind="Type alias">ActivityResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/parent.ts#L85">parent.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Get Pupil details</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#ActivityResponse" class="tsd-signature-type" data-tsd-kind="Type alias">ActivityResponse</a><span class="tsd-signature-symbol">></span></h4><div><p>an array fo Pupils connected to this parent's account</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getStudentInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Student<wbr/>Info<a href="#getStudentInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Student<wbr/>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Student.html" class="tsd-signature-type" data-tsd-kind="Interface">Student</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#getStudentInfo">getStudentInfo</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L71">client.ts:71</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Gets general information about the logged in student</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.Student.html" class="tsd-signature-type" data-tsd-kind="Interface">Student</a><span class="tsd-signature-symbol">></span></h4><div><p>Student object</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="listAnnouncements" class="tsd-anchor"></a><h3 class="tsd-anchor-link">list<wbr/>Announcements<a href="#listAnnouncements" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">list<wbr/>Announcements<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#AnnouncementsResponse" class="tsd-signature-type" data-tsd-kind="Type alias">AnnouncementsResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#listAnnouncements">listAnnouncements</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L181">client.ts:181</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Lists the logged in student's announcements</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#AnnouncementsResponse" class="tsd-signature-type" data-tsd-kind="Type alias">AnnouncementsResponse</a><span class="tsd-signature-symbol">></span></h4><div><p>Array of announcements</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="listHomeworks" class="tsd-anchor"></a><h3 class="tsd-anchor-link">list<wbr/>Homeworks<a href="#listHomeworks" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">list<wbr/>Homeworks<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.GetHomeworkOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetHomeworkOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#HomeworksResponse" class="tsd-signature-type" data-tsd-kind="Type alias">HomeworksResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#listHomeworks">listHomeworks</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L122">client.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Gets a list of the logged in student's homeworks</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/types.GetHomeworkOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetHomeworkOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>GetHomeworkOptions</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/types.html#HomeworksResponse" class="tsd-signature-type" data-tsd-kind="Type alias">HomeworksResponse</a><span class="tsd-signature-symbol">></span></h4><div><p>Array of homeworks</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="login" class="tsd-anchor"></a><h3 class="tsd-anchor-link">login<a href="#login" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">login<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/parent.ts#L41">parent.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Logs the user in the client and authenticates with classcharts</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="makeAuthedRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link">make<wbr/>Authed<wbr/>Request<a href="#makeAuthedRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">make<wbr/>Authed<wbr/>Request<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RequestOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"origin"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"path"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="client.ClasschartsClient.html">ClasschartsClient</a>.<a href="client.ClasschartsClient.html#makeAuthedRequest">makeAuthedRequest</a></p><ul><li>Defined in <a href="https://github.com/ChrisPhillips-cminion/classcharts-api/blob/4f5e091/src/client.ts#L35">client.ts:35</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>path: <span class="tsd-signature-type">string</span></h5></li><li><h5>options: <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RequestOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"origin"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"path"</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/client.html">client</a></li><li class=" tsd-kind-module"><a href="../modules/consts.html">consts</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class="current tsd-kind-module"><a href="../modules/parent.html">parent</a></li><li class=" tsd-kind-module"><a href="../modules/student.html">student</a></li><li class=" tsd-kind-module"><a href="../modules/types.html">types</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="parent.ClasschartsParentClient.html" class="tsd-kind-icon">Classcharts<wbr/>Parent<wbr/>Client</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="parent.ClasschartsParentClient.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#API_BASE" class="tsd-kind-icon">API_<wbr/>BASE</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#authCookies" class="tsd-kind-icon">auth<wbr/>Cookies</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="parent.ClasschartsParentClient.html#email" class="tsd-kind-icon">email</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="parent.ClasschartsParentClient.html#password" class="tsd-kind-icon">password</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#sessionId" class="tsd-kind-icon">session<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#studentId" class="tsd-kind-icon">student<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="parent.ClasschartsParentClient.html#studentName" class="tsd-kind-icon">student<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getActivity" class="tsd-kind-icon">get<wbr/>Activity</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getBadges" class="tsd-kind-icon">get<wbr/>Badges</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getBehaviour" class="tsd-kind-icon">get<wbr/>Behaviour</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getDetentions" class="tsd-kind-icon">get<wbr/>Detentions</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getLessons" class="tsd-kind-icon">get<wbr/>Lessons</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="parent.ClasschartsParentClient.html#getPupils" class="tsd-kind-icon">get<wbr/>Pupils</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#getStudentInfo" class="tsd-kind-icon">get<wbr/>Student<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#listAnnouncements" class="tsd-kind-icon">list<wbr/>Announcements</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#listHomeworks" class="tsd-kind-icon">list<wbr/>Homeworks</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="parent.ClasschartsParentClient.html#login" class="tsd-kind-icon">login</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="parent.ClasschartsParentClient.html#makeAuthedRequest" class="tsd-kind-icon">make<wbr/>Authed<wbr/>Request</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |