Skip to content

Commit

Permalink
CI: automated Generate Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Oct 23, 2024
1 parent a1d5b7f commit 0d40331
Show file tree
Hide file tree
Showing 38 changed files with 539 additions and 539 deletions.
80 changes: 40 additions & 40 deletions docs/classes/index.Client.html
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/classes/models.Error.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Error</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/Error.ts#L13">packages/api/src/models/Error.ts:13</a></li></ul></aside>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/Error.ts#L13">packages/api/src/models/Error.ts:13</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 @@ -68,26 +68,26 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> errors: <span class="t
<h4 class="tsd-returns-title">Returns <a href="models.Error.html" class="tsd-signature-type" data-tsd-kind="Class">Error</a></h4><aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/Error.ts#L22">packages/api/src/models/Error.ts:22</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/Error.ts#L22">packages/api/src/models/Error.ts:22</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-kind-property tsd-parent-kind-class"><a id="errors" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>errors</span><a href="#errors" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">errors<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">APIError</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/Error.ts#L20">packages/api/src/models/Error.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/Error.ts#L20">packages/api/src/models/Error.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Overrides Error.message</p>
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/Error.ts#L16">packages/api/src/models/Error.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/Error.ts#L16">packages/api/src/models/Error.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Overrides Error.name</p>
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/Error.ts#L14">packages/api/src/models/Error.ts:14</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/Error.ts#L14">packages/api/src/models/Error.ts:14</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand All @@ -98,7 +98,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status<wbr/>Code</span><a href="#statusCode" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">status<wbr/>Code<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/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/Error.ts#L18">packages/api/src/models/Error.ts:18</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/Error.ts#L18">packages/api/src/models/Error.ts:18</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/models_builders.IncludesQueryBuilder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">IncludesQueryBuilder</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/builders/IncludesQueryBuilder.ts#L10">packages/api/src/models/builders/IncludesQueryBuilder.ts:10</a></li></ul></aside>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/builders/IncludesQueryBuilder.ts#L10">packages/api/src/models/builders/IncludesQueryBuilder.ts:10</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 @@ -53,14 +53,14 @@ <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="models_builders.IncludesQueryBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">IncludesQueryBuilder</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/builders/IncludesQueryBuilder.ts#L13">packages/api/src/models/builders/IncludesQueryBuilder.ts:13</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/builders/IncludesQueryBuilder.ts#L13">packages/api/src/models/builders/IncludesQueryBuilder.ts:13</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-kind-property tsd-parent-kind-class"><a id="queryParams" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>query<wbr/>Params</span><a href="#queryParams" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">query<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">QueryParamType</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/builders/IncludesQueryBuilder.ts#L11">packages/api/src/models/builders/IncludesQueryBuilder.ts:11</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/builders/IncludesQueryBuilder.ts#L11">packages/api/src/models/builders/IncludesQueryBuilder.ts:11</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"><a id="build" class="tsd-anchor"></a>
Expand All @@ -75,7 +75,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> resourceType: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/builders/IncludesQueryBuilder.ts#L27">packages/api/src/models/builders/IncludesQueryBuilder.ts:27</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/builders/IncludesQueryBuilder.ts#L27">packages/api/src/models/builders/IncludesQueryBuilder.ts:27</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="includes" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>includes</span><a href="#includes" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -88,7 +88,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>key: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="models_builders.IncludesQueryBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">IncludesQueryBuilder</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/561e5c3/packages/api/src/models/builders/IncludesQueryBuilder.ts#L19">packages/api/src/models/builders/IncludesQueryBuilder.ts:19</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/freshbooks/freshbooks-nodejs-sdk/blob/a1d5b7f/packages/api/src/models/builders/IncludesQueryBuilder.ts#L19">packages/api/src/models/builders/IncludesQueryBuilder.ts:19</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading

0 comments on commit 0d40331

Please sign in to comment.