📝 CI: automated Generate Documentation

amcintosh · Mar 28, 2024 · dda968a · dda968a
1 parent 584bdfa
commit dda968a
Show file tree

Hide file tree

Showing 18 changed files with 421 additions and 110 deletions.
diff --git a/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksClientConfigException.html b/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksClientConfigException.html
@@ -163,6 +163,8 @@ <h2 class="phpdocumentor-content__title">
             in package
             <ul class="phpdocumentor-breadcrumbs">
                                     <li class="phpdocumentor-breadcrumb"><a href="packages/amcintosh.html">amcintosh</a></li>
+                                    <li class="phpdocumentor-breadcrumb"><a href="packages/amcintosh-FreshBooks.html">FreshBooks</a></li>
+                                    <li class="phpdocumentor-breadcrumb"><a href="packages/amcintosh-FreshBooks-Exception.html">Exception</a></li>
                             </ul>
         </div>
 
@@ -179,11 +181,12 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksClientConfigException.php"><a href="files/src-exception-freshbooksclientconfigexception.html"><abbr title="src/Exception/FreshBooksClientConfigException.php">FreshBooksClientConfigException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">7</span>
+    <span class="phpdocumentor-element-found-in__line">12</span>
 
     </aside>
 
-
+            <p class="phpdocumentor-summary">Exception thrown when the SDK has not been configured properly.</p>
+
 
 
 
@@ -245,7 +248,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksClientConfigException.php"><a href="files/src-exception-freshbooksclientconfigexception.html"><abbr title="src/Exception/FreshBooksClientConfigException.php">FreshBooksClientConfigException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">9</span>
+    <span class="phpdocumentor-element-found-in__line">14</span>
 
     </aside>
 

diff --git a/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksException.html b/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksException.html
@@ -163,6 +163,8 @@ <h2 class="phpdocumentor-content__title">
             in package
             <ul class="phpdocumentor-breadcrumbs">
                                     <li class="phpdocumentor-breadcrumb"><a href="packages/amcintosh.html">amcintosh</a></li>
+                                    <li class="phpdocumentor-breadcrumb"><a href="packages/amcintosh-FreshBooks.html">FreshBooks</a></li>
+                                    <li class="phpdocumentor-breadcrumb"><a href="packages/amcintosh-FreshBooks-Exception.html">Exception</a></li>
                             </ul>
         </div>
 
@@ -179,11 +181,12 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">7</span>
+    <span class="phpdocumentor-element-found-in__line">12</span>
 
     </aside>
 
-
+            <p class="phpdocumentor-summary">Exception thrown when the FreshBooks API returns an error.</p>
+
 
 
 
@@ -290,7 +293,7 @@ <h4 class="phpdocumentor-element__name" id="property_errorCode">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">10</span>
+    <span class="phpdocumentor-element-found-in__line">15</span>
 
     </aside>
 
@@ -323,7 +326,7 @@ <h4 class="phpdocumentor-element__name" id="property_errorDetails">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">11</span>
+    <span class="phpdocumentor-element-found-in__line">16</span>
 
     </aside>
 
@@ -356,7 +359,7 @@ <h4 class="phpdocumentor-element__name" id="property_rawResponse">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">9</span>
+    <span class="phpdocumentor-element-found-in__line">14</span>
 
     </aside>
 
@@ -394,7 +397,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">13</span>
+    <span class="phpdocumentor-element-found-in__line">18</span>
 
     </aside>
 
@@ -470,7 +473,7 @@ <h4 class="phpdocumentor-element__name" id="method_getErrorCode">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">33</span>
+    <span class="phpdocumentor-element-found-in__line">38</span>
 
     </aside>
 
@@ -505,7 +508,7 @@ <h4 class="phpdocumentor-element__name" id="method_getErrorDetails">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">38</span>
+    <span class="phpdocumentor-element-found-in__line">43</span>
 
     </aside>
 
@@ -540,7 +543,7 @@ <h4 class="phpdocumentor-element__name" id="method_getRawResponse">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksException.php"><a href="files/src-exception-freshbooksexception.html"><abbr title="src/Exception/FreshBooksException.php">FreshBooksException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">28</span>
+    <span class="phpdocumentor-element-found-in__line">33</span>
 
     </aside>
 

diff --git a/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksNotImplementedException.html b/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksNotImplementedException.html
@@ -163,6 +163,8 @@ <h2 class="phpdocumentor-content__title">
             in package
             <ul class="phpdocumentor-breadcrumbs">
                                     <li class="phpdocumentor-breadcrumb"><a href="packages/amcintosh.html">amcintosh</a></li>
+                                    <li class="phpdocumentor-breadcrumb"><a href="packages/amcintosh-FreshBooks.html">FreshBooks</a></li>
+                                    <li class="phpdocumentor-breadcrumb"><a href="packages/amcintosh-FreshBooks-Exception.html">Exception</a></li>
                             </ul>
         </div>
 
@@ -179,11 +181,12 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksNotImplementedException.php"><a href="files/src-exception-freshbooksnotimplementedexception.html"><abbr title="src/Exception/FreshBooksNotImplementedException.php">FreshBooksNotImplementedException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">7</span>
+    <span class="phpdocumentor-element-found-in__line">12</span>
 
     </aside>
 
-
+            <p class="phpdocumentor-summary">Exception thrown when attempting to make an API call that is not supported.</p>
+
 
 
 
@@ -245,7 +248,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Exception/FreshBooksNotImplementedException.php"><a href="files/src-exception-freshbooksnotimplementedexception.html"><abbr title="src/Exception/FreshBooksNotImplementedException.php">FreshBooksNotImplementedException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">9</span>
+    <span class="phpdocumentor-element-found-in__line">14</span>
 
     </aside>