Separate classes for groups of methods (#1)

* added resourcetype interface that's imported and reused

* added membergroupmembership; comments formatting typedoc output; updated types

* separate classes for groups of methods

* additional methods added, suggested changes made, typedoc documentation improved
This commit is contained in:
Nick Trochalakis authored and GitHub committed 2025-01-11 14:57:09 -08:00
1 parent 27b6abc928
commit 7254e6e5b3
110 files changed
+2199 -1326

No files matched your search

+12
View File
@@ -0,0 +1,12 @@
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MemberAwards | d4h-typescript</title><meta name="description" content="Documentation for d4h-typescript"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">d4h-typescript</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">d4h-typescript</a></li><li><a href="../modules/index.html">index</a></li><li><a href="index.MemberAwards.html">MemberAwards</a></li></ul><h1>Interface MemberAwards</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MemberAwards</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="index.MemberAwards.html#createdat">createdAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="index.MemberAwards.html#custom_fields">custom_fields</a><span class="tsd-signature-symbol">?:</span> <a href="index.CustomField.html" class="tsd-signature-type tsd-kind-interface">CustomField</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="index.MemberAwards.html#endsat">endsAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="index.MemberAwards.html#entitytype">entityType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EntityType</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="index.MemberAwards.html#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="index.MemberAwards.html#member">member</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <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><br/>    <a class="tsd-kind-property" href="index.MemberAwards.html#owner">owner</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">:</spanLine truncated
<a href="index.MemberAwards.html#custom_fields" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom_<wbr/>fields?</span></a>
<a href="index.MemberAwards.html#endsat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ends<wbr/>At</span></a>
<a href="index.MemberAwards.html#entitytype" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entity<wbr/>Type</span></a>
<a href="index.MemberAwards.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
<a href="index.MemberAwards.html#member" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>member</span></a>
<a href="index.MemberAwards.html#owner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a>
<a href="index.MemberAwards.html#qualification" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>qualification</span></a>
<a href="index.MemberAwards.html#resourcetype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resource<wbr/>Type</span></a>
<a href="index.MemberAwards.html#startsat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>starts<wbr/>At</span></a>
<a href="index.MemberAwards.html#updatedat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>updated<wbr/>At</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="createdat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>created<wbr/>At</span><a href="#createdat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createdAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kc4x4sar/d4h-typescript/blob/e1c990c707b1cc5ecf94b527bc781a7a6df5299d/lib/src/types/qualification.ts#L20">src/types/qualification.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="custom_fields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>custom_<wbr/>fields</span><a href="#custom_fields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">custom_fields</span><span class="tsd-signature-symbol">?:</span> <a href="index.CustomField.html" class="tsd-signature-type tsd-kind-interface">CustomField</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from Entity.custom_fields</p><ul><li>Defined in <a href="https://github.com/kc4x4sar/d4h-typescript/blob/e1c990c707b1cc5ecf94b527bc781a7a6df5299d/lib/src/entity.ts#L4">src/entity.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="endsat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ends<wbr/>At</span><a href="#endsat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">endsAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kc4x4sar/d4h-typescript/blob/e1c990c707b1cc5ecf94b527bc781a7a6df5299d/lib/src/types/qualification.ts#L24">src/types/qualification.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="entitytype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>entity<wbr/>Type</span><a href="#entitytype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">entityType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EntityType</span></div><aside class="tsd-sources"><p>Inherited from Entity.entityType</p><ul><li>Defined in <a href="https://github.com/kc4x4sar/d4h-typescript/blob/e1c990c707b1cc5ecf94b527bc781a7a6df5299d/lib/src/entity.ts#L6">src/entity.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Overrides Entity.id</p><ul><li>Defined in <a href="https://github.com/kc4x4sar/d4h-typescript/blob/e1c990c707b1cc5ecf94b527bc781a7a6df5299d/lib/src/types/qualification.ts#L19">src/types/qualification.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="member" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>member</span><a href="#member" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">member</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> Line truncated