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 Feb 6, 2022
1 parent 4efcb60 commit d8d89d8
Show file tree
Hide file tree
Showing 6 changed files with 1,139 additions and 0 deletions.
918 changes: 918 additions & 0 deletions docs/classes/amcintosh-FreshBooks-Builder-FilterBuilder.html
View file

Large diffs are not rendered by default.

161 changes: 161 additions & 0 deletions docs/files/src-builder-filterbuilder.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</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">Documentation</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">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/Application.html" class="">Application</a>
</h4>

<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">FilterBuilder.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-Builder-FilterBuilder.html"><abbr title="\amcintosh\FreshBooks\Builder\FilterBuilder">FilterBuilder</abbr></a></dt>
<dd>Builder for making filtered list queries.</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-builder-filterbuilder.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/indices/files.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ <h3>E</h3>
</ul>
<h3>F</h3>
<ul class="phpdocumentor-list">
<li><a href="files/src-builder-filterbuilder.html"><abbr title="src/Builder/FilterBuilder.php">FilterBuilder.php</abbr></a></li>
<li><a href="files/src-freshbooksclient.html"><abbr title="src/FreshBooksClient.php">FreshBooksClient.php</abbr></a></li>
<li><a href="files/src-freshbooksclientconfig.html"><abbr title="src/FreshBooksClientConfig.php">FreshBooksClientConfig.php</abbr></a></li>
<li><a href="files/src-exception-freshbooksclientconfigexception.html"><abbr title="src/Exception/FreshBooksClientConfigException.php">FreshBooksClientConfigException.php</abbr></a></li>
Expand Down
55 changes: 55 additions & 0 deletions docs/js/searchIndex.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,61 @@ Search.appendIndex(
"name": "build",
"summary": "Builds\u0020the\u0020query\u0020string\u0020parameters\u0020from\u0020the\u0020Builder.",
"url": "classes/amcintosh-FreshBooks-Builder-BuilderInterface.html#method_build"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder",
"name": "FilterBuilder",
"summary": "Builder\u0020for\u0020making\u0020filtered\u0020list\u0020queries.",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003A__construct\u0028\u0029",
"name": "__construct",
"summary": "Builder\u0020for\u0020making\u0020filtered\u0020list\u0020queries.",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method___construct"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003Abetween\u0028\u0029",
"name": "between",
"summary": "Filters\u0020results\u0020where\u0020the\u0020provided\u0020field\u0020is\u0020between\u0020two\u0020values.",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method_between"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003AconvertBetweenKey\u0028\u0029",
"name": "convertBetweenKey",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method_convertBetweenKey"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003AconvertBetweenValue\u0028\u0029",
"name": "convertBetweenValue",
"summary": "",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method_convertBetweenValue"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003Aboolean\u0028\u0029",
"name": "boolean",
"summary": "Filters\u0020results\u0020where\u0020the\u0020field\u0020is\u0020equal\u0020to\u0020true\u0020or\u0020false.",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method_boolean"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003Adatetime\u0028\u0029",
"name": "datetime",
"summary": "Filters\u0020for\u0020entries\u0020that\u0020come\u0020before\u0020or\u0020after\u0020a\u0020particular\u0020time,\u0020as\u0020specified\nby\u0020the\u0020field.",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method_datetime"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003Aequals\u0028\u0029",
"name": "equals",
"summary": "Filters\u0020results\u0020where\u0020the\u0020field\u0020is\u0020equal\u0020to\u0020the\u0020provided\u0020value.",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method_equals"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003AinList\u0028\u0029",
"name": "inList",
"summary": "Filters\u0020if\u0020the\u0020provided\u0020field\u0020matches\u0020a\u0020value\u0020in\u0020a\u0020list.",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method_inList"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003Alike\u0028\u0029",
"name": "like",
"summary": "Filters\u0020for\u0020a\u0020match\u0020contained\u0020within\u0020the\u0020field\u0020being\u0020searched.\u0020For\u0020example,\n\u0022leaf\u0022\u0020will\u0020Like\u002Dmatch\u0020\u0022aleaf\u0022\u0020and\u0020\u0022leafy\u0022,\u0020but\u0020not\u0020\u0022leav\u0022,\u0020and\u0020\u0022leafs\u0022\u0020would\nnot\u0020Like\u002Dmatch\u0020\u0022leaf\u0022.",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method_like"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\FilterBuilder\u003A\u003Abuild\u0028\u0029",
"name": "build",
"summary": "Builds\u0020the\u0020query\u0020string\u0020parameters\u0020from\u0020the\u0020Builder.",
"url": "classes/amcintosh-FreshBooks-Builder-FilterBuilder.html#method_build"
}, {
"fqsen": "\\amcintosh\\FreshBooks\\Builder\\IncludesBuilder",
"name": "IncludesBuilder",
Expand Down
2 changes: 2 additions & 0 deletions docs/namespaces/amcintosh-freshbooks-builder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ <h3 id="interfaces_class_traits">
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/amcintosh-FreshBooks-Builder-BuilderInterface.html"><abbr title="\amcintosh\FreshBooks\Builder\BuilderInterface">BuilderInterface</abbr></a></dt>
<dd></dd>

<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Builder-FilterBuilder.html"><abbr title="\amcintosh\FreshBooks\Builder\FilterBuilder">FilterBuilder</abbr></a></dt>
<dd>Builder for making filtered list queries.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Builder-IncludesBuilder.html"><abbr title="\amcintosh\FreshBooks\Builder\IncludesBuilder">IncludesBuilder</abbr></a></dt>
<dd>Builder for including relationships, sub-resources, or additional data in the response.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Builder-PaginateBuilder.html"><abbr title="\amcintosh\FreshBooks\Builder\PaginateBuilder">PaginateBuilder</abbr></a></dt>
Expand Down
2 changes: 2 additions & 0 deletions docs/packages/amcintosh-FreshBooks-Builder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ <h3 id="interfaces_class_traits">

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

<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Builder-FilterBuilder.html"><abbr title="\amcintosh\FreshBooks\Builder\FilterBuilder">FilterBuilder</abbr></a></dt>
<dd>Builder for making filtered list queries.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Builder-IncludesBuilder.html"><abbr title="\amcintosh\FreshBooks\Builder\IncludesBuilder">IncludesBuilder</abbr></a></dt>
<dd>Builder for including relationships, sub-resources, or additional data in the response.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/amcintosh-FreshBooks-Builder-PaginateBuilder.html"><abbr title="\amcintosh\FreshBooks\Builder\PaginateBuilder">PaginateBuilder</abbr></a></dt>
Expand Down

0 comments on commit d8d89d8

Please sign in to comment.