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 May 15, 2022
1 parent da572c0 commit 15a61f1
Show file tree
Hide file tree
Showing 8 changed files with 977 additions and 85 deletions.
166 changes: 106 additions & 60 deletions docs/html/classes/amcintosh-FreshBooks-Model-Invoice.html

Large diffs are not rendered by default.

612 changes: 612 additions & 0 deletions docs/html/classes/amcintosh-FreshBooks-Model-InvoicePresentation.html

Large diffs are not rendered by default.

206 changes: 206 additions & 0 deletions docs/html/files/src-model-invoicepresentation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>freshbooks-php-sdk</title>

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">freshbooks-php-sdk</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>

<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>

<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guide/installation.html" class="">Installation</a>
</h4>

<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guide/configuration.html" class="">Configuring The API Client</a>
</h4>

<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guide/authorization.html" class="">Authorization Flow</a>
</h4>

<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guide/api-calls/index.html" class="">Making API Calls</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guide/api-calls/current-user.html" class="">Current User</a>

</li>
<li>
<a href="guide/api-calls/decimals.html" class="">Decimal Values</a>

</li>
<li>
<a href="guide/api-calls/get-list.html" class="">Get and List</a>

</li>
<li>
<a href="guide/api-calls/create-update-delete.html" class="">Create, Update, and Delete</a>

</li>
<li>
<a href="guide/api-calls/errors.html" class="">Error Handling</a>

</li>
<li>
<a href="guide/api-calls/builders.html" class="">Pagination, Filters, and Includes</a>

</li>
</ul>

<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guide/examples.html" class="">Examples and Sample Code</a>
</h4>

</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/amcintosh.html" class="">amcintosh</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/amcintosh-freshbooks.html" class="">FreshBooks</a>

</li>
</ul>

</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/amcintosh.html" class="">amcintosh</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/amcintosh-FreshBooks.html" class="">FreshBooks</a>

</li>
</ul>

</section>

<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>

<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>

<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
</ul>

<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">InvoicePresentation.php</h2>


<section class="phpdocumentor-description"></section>






<h3 id="interfaces_class_traits">
Interfaces, Classes, Traits and Enums
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
</h3>

<dl class="phpdocumentor-table-of-contents">

<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Model-InvoicePresentation.html"><abbr title="\amcintosh\FreshBooks\Model\InvoicePresentation">InvoicePresentation</abbr></a></dt>
<dd>Invoice Presentations are used to style an invoice including font, colors, and logos.</dd>


</dl>








</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="files/src-model-invoicepresentation.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>

</main>

<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
1 change: 1 addition & 0 deletions docs/html/indices/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ <h3>I</h3>
<li><a href="files/src-builder-includesbuilder.html"><abbr title="src/Builder/IncludesBuilder.php">IncludesBuilder.php</abbr></a></li>
<li><a href="files/src-model-invoice.html"><abbr title="src/Model/Invoice.php">Invoice.php</abbr></a></li>
<li><a href="files/src-model-invoicelist.html"><abbr title="src/Model/InvoiceList.php">InvoiceList.php</abbr></a></li>
<li><a href="files/src-model-invoicepresentation.html"><abbr title="src/Model/InvoicePresentation.php">InvoicePresentation.php</abbr></a></li>
<li><a href="files/src-model-invoicestatus.html"><abbr title="src/Model/InvoiceStatus.php">InvoiceStatus.php</abbr></a></li>
<li><a href="files/src-model-item.html"><abbr title="src/Model/Item.php">Item.php</abbr></a></li>
<li><a href="files/src-model-itemlist.html"><abbr title="src/Model/ItemList.php">ItemList.php</abbr></a></li>
Expand Down
45 changes: 45 additions & 0 deletions docs/html/js/searchIndex.js
Original file line number Diff line number Diff line change
Expand Up @@ -1360,6 +1360,11 @@ Search.appendIndex(
"name": "PONumber",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-Invoice.html#property_PONumber"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\Invoice\u003A\u003A\u0024presentation",
"name": "presentation",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-Invoice.html#property_presentation"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\Invoice\u003A\u003A\u0024province",
"name": "province",
Expand Down Expand Up @@ -1460,6 +1465,46 @@ Search.appendIndex(
"name": "invoices",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-InvoiceList.html#property_invoices"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation",
"name": "InvoicePresentation",
"summary": "Invoice\u0020Presentations\u0020are\u0020used\u0020to\u0020style\u0020an\u0020invoice\u0020including\u0020font,\u0020colors,\u0020and\u0020logos.",
"url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024invoiceId",
"name": "invoiceId",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_invoiceId"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024dateFormat",
"name": "dateFormat",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_dateFormat"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024imageBannerSrc",
"name": "imageBannerSrc",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_imageBannerSrc"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024imageLogoSrc",
"name": "imageLogoSrc",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_imageLogoSrc"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024themeFontName",
"name": "themeFontName",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_themeFontName"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024themeLayout",
"name": "themeLayout",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_themeLayout"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024themePrimaryColor",
"name": "themePrimaryColor",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_themePrimaryColor"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoiceStatus",
"name": "InvoiceStatus",
Expand Down
2 changes: 2 additions & 0 deletions docs/html/namespaces/amcintosh-freshbooks-model.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,8 @@ <h3 id="interfaces_class_traits">
that Client owes to the Admin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Model-InvoiceList.html"><abbr title="\amcintosh\FreshBooks\Model\InvoiceList">InvoiceList</abbr></a></dt>
<dd>Results of invoices list call containing list of invoices and pagination data.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Model-InvoicePresentation.html"><abbr title="\amcintosh\FreshBooks\Model\InvoicePresentation">InvoicePresentation</abbr></a></dt>
<dd>Invoice Presentations are used to style an invoice including font, colors, and logos.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Model-InvoiceStatus.html"><abbr title="\amcintosh\FreshBooks\Model\InvoiceStatus">InvoiceStatus</abbr></a></dt>
<dd>Status values for an invoice.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Model-Item.html"><abbr title="\amcintosh\FreshBooks\Model\Item">Item</abbr></a></dt>
Expand Down
2 changes: 2 additions & 0 deletions docs/html/packages/amcintosh-FreshBooks-Model.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,8 @@ <h3 id="interfaces_class_traits">
that Client owes to the Admin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Model-InvoiceList.html"><abbr title="\amcintosh\FreshBooks\Model\InvoiceList">InvoiceList</abbr></a></dt>
<dd>Results of invoices list call containing list of invoices and pagination data.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Model-InvoicePresentation.html"><abbr title="\amcintosh\FreshBooks\Model\InvoicePresentation">InvoicePresentation</abbr></a></dt>
<dd>Invoice Presentations are used to style an invoice including font, colors, and logos.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Model-InvoiceStatus.html"><abbr title="\amcintosh\FreshBooks\Model\InvoiceStatus">InvoiceStatus</abbr></a></dt>
<dd>Status values for an invoice.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Model-Item.html"><abbr title="\amcintosh\FreshBooks\Model\Item">Item</abbr></a></dt>
Expand Down
28 changes: 3 additions & 25 deletions docs/html/reports/markers.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,32 +151,10 @@ <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Fil
<div class="phpdocumentor-row">
<h2 class="phpdocumentor-content__title">Markers</h2>

<h3>Table of Contents</h3>
<table class="phpdocumentor-table_of_contents">
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/Model/Invoice.php">src/Model/Invoice.php</a></td>
<td class="phpdocumentor-cell">1</td>
</tr>
</table>
<div class="phpdocumentor-admonition phpdocumentor-admonition--success">
No markers have been found in this project.
</div>

<a id="src/Model/Invoice.php"></a>
<h3><abbr title="src/Model/Invoice.php">Invoice.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">374</td>
<td class="phpdocumentor-cell">make presentation</td>
</tr>
</tbody>
</table>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
Expand Down

0 comments on commit 15a61f1

Please sign in to comment.