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 committed Aug 10, 2023
1 parent 97f9862 commit e92a855
Show file tree
Hide file tree
Showing 23 changed files with 2,027 additions and 11 deletions.
16 changes: 16 additions & 0 deletions docs/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,22 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Results of taxes list call containing list of taxes and pagination data.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="net/amcintosh/freshbooks/resources/TimeEntries.html" title="class in net.amcintosh.freshbooks.resources">TimeEntries</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">FreshBooks TimeEntries resource with calls to get, list, create, update, delete</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="net/amcintosh/freshbooks/models/TimeEntry.html" title="class in net.amcintosh.freshbooks.models">TimeEntry</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Time Entries represent time spent working for a client or project.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="net/amcintosh/freshbooks/models/TimeEntryList.html" title="class in net.amcintosh.freshbooks.models">TimeEntryList</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Results of time_entries list call containing list of time_entry, pagination, and billing data.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="net/amcintosh/freshbooks/resources/api/TimeTrackingResource.html" title="class in net.amcintosh.freshbooks.resources.api">TimeTrackingResource</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Handles resources under the '<code>/timetracking</code>'.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="net/amcintosh/freshbooks/Util.html" title="class in net.amcintosh.freshbooks">Util</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Utility functions.</div>
Expand Down
233 changes: 233 additions & 0 deletions docs/index-all.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/member-search-index.js

Large diffs are not rendered by default.

22 changes: 19 additions & 3 deletions docs/net/amcintosh/freshbooks/FreshBooksClient.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,9 +218,14 @@ <h2>Method Summary</h2>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">FreshBooks taxes resource with calls to get, list, create, update, delete.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="resources/TimeEntries.html" title="class in net.amcintosh.freshbooks.resources">TimeEntries</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#timeEntries()" class="member-name-link">timeEntries</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">FreshBooks time entries resource with calls to get, list, create, update, delete.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -545,6 +550,17 @@ <h3>taxes</h3>
</dl>
</section>
</li>
<li>
<section class="detail" id="timeEntries()">
<h3>timeEntries</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="resources/TimeEntries.html" title="class in net.amcintosh.freshbooks.resources">TimeEntries</a></span>&nbsp;<span class="element-name">timeEntries</span>()</div>
<div class="block">FreshBooks time entries resource with calls to get, list, create, update, delete.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>TimeEntries resource initialized with this FreshBooksClient</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/net/amcintosh/freshbooks/models/Invoice.html
Original file line number Diff line number Diff line change
Expand Up @@ -773,7 +773,7 @@ <h3>getInvoiceId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getInvoiceId</span>()</div>
<div class="block">Get unique to this business id for invoice.

Note: This is the same as <code>getId</code>.</div>
<i>Note:</i> This is the same as <code>getId</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The id of the invoice</dd>
Expand Down
2 changes: 1 addition & 1 deletion docs/net/amcintosh/freshbooks/models/ListResult.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h1 title="Class ListResult" class="title">Class ListResult</h1>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="ClientList.html" title="class in net.amcintosh.freshbooks.models">ClientList</a></code>, <code><a href="ExpenseList.html" title="class in net.amcintosh.freshbooks.models">ExpenseList</a></code>, <code><a href="InvoiceList.html" title="class in net.amcintosh.freshbooks.models">InvoiceList</a></code>, <code><a href="ItemList.html" title="class in net.amcintosh.freshbooks.models">ItemList</a></code>, <code><a href="OtherIncomeList.html" title="class in net.amcintosh.freshbooks.models">OtherIncomeList</a></code>, <code><a href="PaymentList.html" title="class in net.amcintosh.freshbooks.models">PaymentList</a></code>, <code><a href="ProjectList.html" title="class in net.amcintosh.freshbooks.models">ProjectList</a></code>, <code><a href="ServiceList.html" title="class in net.amcintosh.freshbooks.models">ServiceList</a></code>, <code><a href="TaskList.html" title="class in net.amcintosh.freshbooks.models">TaskList</a></code>, <code><a href="TaxList.html" title="class in net.amcintosh.freshbooks.models">TaxList</a></code></dd>
<dd><code><a href="ClientList.html" title="class in net.amcintosh.freshbooks.models">ClientList</a></code>, <code><a href="ExpenseList.html" title="class in net.amcintosh.freshbooks.models">ExpenseList</a></code>, <code><a href="InvoiceList.html" title="class in net.amcintosh.freshbooks.models">InvoiceList</a></code>, <code><a href="ItemList.html" title="class in net.amcintosh.freshbooks.models">ItemList</a></code>, <code><a href="OtherIncomeList.html" title="class in net.amcintosh.freshbooks.models">OtherIncomeList</a></code>, <code><a href="PaymentList.html" title="class in net.amcintosh.freshbooks.models">PaymentList</a></code>, <code><a href="ProjectList.html" title="class in net.amcintosh.freshbooks.models">ProjectList</a></code>, <code><a href="ServiceList.html" title="class in net.amcintosh.freshbooks.models">ServiceList</a></code>, <code><a href="TaskList.html" title="class in net.amcintosh.freshbooks.models">TaskList</a></code>, <code><a href="TaxList.html" title="class in net.amcintosh.freshbooks.models">TaxList</a></code>, <code><a href="TimeEntryList.html" title="class in net.amcintosh.freshbooks.models">TimeEntryList</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ListResult</span>
Expand Down
8 changes: 6 additions & 2 deletions docs/net/amcintosh/freshbooks/models/Project.html
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,9 @@ <h3>getId</h3>
<section class="detail" id="getActive()">
<h3>getActive</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getActive</span>()</div>
<div class="block">Whether the project is active or not.</div>
<div class="block">Whether the project is active or not.
<br><br>
<i>Note: A resource that is not active is essentially a "soft" delete.</i></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>True if active</dd>
Expand All @@ -432,7 +434,9 @@ <h3>getActive</h3>
<section class="detail" id="setActive(boolean)">
<h3>setActive</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setActive</span><wbr><span class="parameters">(boolean&nbsp;active)</span></div>
<div class="block">Set whether the project is active or not.</div>
<div class="block">Set whether the project is active or not.
<br><br>
<i>Note: A resource that is not active is essentially a "soft" delete.</i></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>active</code> - active</dd>
Expand Down
Loading

0 comments on commit e92a855

Please sign in to comment.