Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierce01 committed Sep 22, 2023
1 parent ecae9ea commit ac40674
Show file tree
Hide file tree
Showing 71 changed files with 2,046 additions and 584 deletions.
43 changes: 2 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,5 @@ A TypeScript wrapper for TerminalFour's REST API

## Installing
`npm install t4.ts`
### Endpoints:
- Client
- call
- verify
- Content
- get
- getVersions
- getWithoutSection
- delete
- ContentType
- list
- listType
- Download
- getFileFromElement
- getFileFromElementVersion
- FormBuilder
- list
- Hierarchy
- get
- getSection
- getContents
- delete
- update
- Media
- list
- utils
- getMediaIDs
- add
- get
- getMediaUsage
- bulkGetMediaUsage
- downloadSingle
- MediaCategory
- list
- get
- update
- MediaType
- list
- Profile
- get
- update
### Documentation:
TypeDoc: https://pierce01.github.io/t4.ts/
2 changes: 1 addition & 1 deletion docs/assets/navigation.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

47 changes: 22 additions & 25 deletions docs/classes/Client.html

Large diffs are not rendered by default.

90 changes: 81 additions & 9 deletions docs/classes/_internal_.Content.html

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions docs/classes/_internal_.ContentType.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ContentType</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/ContentType.ts#L4">lib/ContentType.ts:4</a></li></ul></aside>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/ContentType.ts#L4">lib/ContentType.ts:4</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">
Expand All @@ -37,8 +37,8 @@ <h3 class="tsd-index-heading">Properties</h3>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Methods</h3>
<div class="tsd-index-list"><a href="_internal_.ContentType.html#list" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list</span></a>
<a href="_internal_.ContentType.html#listType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Type</span></a>
<div class="tsd-index-list"><a href="_internal_.ContentType.html#get" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get</span></a>
<a href="_internal_.ContentType.html#list" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Constructors</h2>
Expand All @@ -54,28 +54,20 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">client</span>: <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="_internal_.ContentType.html" class="tsd-signature-type tsd-kind-class">ContentType</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/ContentType.ts#L6">lib/ContentType.ts:6</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/ContentType.ts#L6">lib/ContentType.ts:6</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="clinet" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>clinet</span><a href="#clinet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">clinet</span><span class="tsd-signature-symbol">:</span> <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/ContentType.ts#L5">lib/ContentType.ts:5</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/ContentType.ts#L5">lib/ContentType.ts:5</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="list" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>list</span><a href="#list" 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="list.list-1"><span class="tsd-kind-call-signature">list</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#list.list-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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/ContentType.ts#L10">lib/ContentType.ts:10</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="listType" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>list<wbr/>Type</span><a href="#listType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<section class="tsd-panel tsd-member"><a id="get" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get</span><a href="#get" 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="listType.listType-1"><span class="tsd-kind-call-signature">list<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contentTypeId</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#listType.listType-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-signature tsd-anchor-link" id="get.get-1"><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contentTypeId</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#get.get-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-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -84,7 +76,15 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">contentTypeId</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/ContentType.ts#L15">lib/ContentType.ts:15</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/ContentType.ts#L15">lib/ContentType.ts:15</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="list" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>list</span><a href="#list" 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="list.list-1"><span class="tsd-kind-call-signature">list</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#list.list-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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/ContentType.ts#L10">lib/ContentType.ts:10</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand All @@ -105,8 +105,8 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<ul>
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
<li><a href="#clinet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>clinet</span></a></li>
<li><a href="#list" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list</span></a></li>
<li><a href="#listType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Type</span></a></li></ul></div></details></div>
<li><a href="#get" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get</span></a></li>
<li><a href="#list" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list</span></a></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>t4.ts</span></a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/_internal_.Download.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Download</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/Download.ts#L5">lib/Download.ts:5</a></li></ul></aside>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/Download.ts#L5">lib/Download.ts:5</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">
Expand Down Expand Up @@ -54,14 +54,14 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">client</span>: <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="_internal_.Download.html" class="tsd-signature-type tsd-kind-class">Download</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/Download.ts#L7">lib/Download.ts:7</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/Download.ts#L7">lib/Download.ts:7</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="client" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>client</span><a href="#client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">:</span> <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/Download.ts#L6">lib/Download.ts:6</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/Download.ts#L6">lib/Download.ts:6</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="getFileFromElement" class="tsd-anchor"></a>
Expand All @@ -80,7 +80,7 @@ <h5><span class="tsd-kind-parameter">contentId</span>: <span class="tsd-signatur
<h5><span class="tsd-kind-parameter">language</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Types.FileDownload.html" class="tsd-signature-type tsd-kind-interface">FileDownload</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/Download.ts#L11">lib/Download.ts:11</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/Download.ts#L11">lib/Download.ts:11</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getFileFromElementVersion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>File<wbr/>From<wbr/>Element<wbr/>Version</span><a href="#getFileFromElementVersion" 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">
Expand All @@ -99,7 +99,7 @@ <h5><span class="tsd-kind-parameter">language</span>: <span class="tsd-signature
<h5><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Types.FileDownload.html" class="tsd-signature-type tsd-kind-interface">FileDownload</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ae1aede/src/lib/Download.ts#L16">lib/Download.ts:16</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/Pierce01/t4.ts/blob/ecae9ea/src/lib/Download.ts#L16">lib/Download.ts:16</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit ac40674

Please sign in to comment.