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 Mar 30, 2024
1 parent 47a8566 commit 423cc08
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 303 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -360,20 +360,6 @@ <h4 id="toc-methods">
</dt>
<dd>Make a request against the accounting resource and return an array of the json response.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_createNewResponseError">createNewResponseError()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Parse the json response for new-style accounting endpoint errors and create a FreshBooksException from it.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_createOldResponseError">createOldResponseError()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Parse the json response for old-style accounting endpoint errors and create a FreshBooksException from it.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_rejectMissing">rejectMissing()</a>
<span>
Expand Down Expand Up @@ -837,7 +823,7 @@ <h4 class="phpdocumentor-element__name" id="method_create">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Resource/AccountingResource.php"><a href="files/src-resource-accountingresource.html"><abbr title="src/Resource/AccountingResource.php">AccountingResource.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">211</span>
<span class="phpdocumentor-element-found-in__line">166</span>

</aside>

Expand Down Expand Up @@ -914,7 +900,7 @@ <h4 class="phpdocumentor-element__name" id="method_delete">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Resource/AccountingResource.php"><a href="files/src-resource-accountingresource.html"><abbr title="src/Resource/AccountingResource.php">AccountingResource.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">263</span>
<span class="phpdocumentor-element-found-in__line">218</span>

</aside>

Expand Down Expand Up @@ -978,7 +964,7 @@ <h4 class="phpdocumentor-element__name" id="method_get">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Resource/AccountingResource.php"><a href="files/src-resource-accountingresource.html"><abbr title="src/Resource/AccountingResource.php">AccountingResource.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">180</span>
<span class="phpdocumentor-element-found-in__line">135</span>

</aside>

Expand Down Expand Up @@ -1046,7 +1032,7 @@ <h4 class="phpdocumentor-element__name" id="method_list">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Resource/AccountingResource.php"><a href="files/src-resource-accountingresource.html"><abbr title="src/Resource/AccountingResource.php">AccountingResource.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">195</span>
<span class="phpdocumentor-element-found-in__line">150</span>

</aside>

Expand Down Expand Up @@ -1107,7 +1093,7 @@ <h4 class="phpdocumentor-element__name" id="method_update">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Resource/AccountingResource.php"><a href="files/src-resource-accountingresource.html"><abbr title="src/Resource/AccountingResource.php">AccountingResource.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">236</span>
<span class="phpdocumentor-element-found-in__line">191</span>

</aside>

Expand Down Expand Up @@ -1291,7 +1277,7 @@ <h4 class="phpdocumentor-element__name" id="method_handleError">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Resource/AccountingResource.php"><a href="files/src-resource-accountingresource.html"><abbr title="src/Resource/AccountingResource.php">AccountingResource.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">155</span>
<span class="phpdocumentor-element-found-in__line">105</span>

</aside>

Expand Down Expand Up @@ -1400,130 +1386,6 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
</section>

</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_createNewResponseError">
createNewResponseError()
<a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_createNewResponseError" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Resource/AccountingResource.php"><a href="files/src-resource-accountingresource.html"><abbr title="src/Resource/AccountingResource.php">AccountingResource.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">127</span>

</aside>

<p class="phpdocumentor-summary">Parse the json response for new-style accounting endpoint errors and create a FreshBooksException from it.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">createNewResponseError</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statusCode</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$responseData</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$rawRespone</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>

<div class="phpdocumentor-label-line">
</div>

<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$statusCode</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>HTTP status code</p>
</section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$responseData</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The json-parsed response</p>
</section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$rawRespone</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The raw response body</p>
</section>

</dd>
</dl>




</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_createOldResponseError">
createOldResponseError()
<a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_createOldResponseError" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Resource/AccountingResource.php"><a href="files/src-resource-accountingresource.html"><abbr title="src/Resource/AccountingResource.php">AccountingResource.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>

</aside>

<p class="phpdocumentor-summary">Parse the json response for old-style accounting endpoint errors and create a FreshBooksException from it.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">createOldResponseError</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statusCode</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$responseData</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$rawRespone</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>

<div class="phpdocumentor-label-line">
</div>

<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$statusCode</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>HTTP status code</p>
</section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$responseData</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The json-parsed response</p>
</section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$rawRespone</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The raw response body</p>
</section>

</dd>
</dl>




</article>
<article
class="phpdocumentor-element
Expand All @@ -1539,7 +1401,7 @@ <h4 class="phpdocumentor-element__name" id="method_rejectMissing">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Resource/AccountingResource.php"><a href="files/src-resource-accountingresource.html"><abbr title="src/Resource/AccountingResource.php">AccountingResource.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">166</span>
<span class="phpdocumentor-element-found-in__line">121</span>

</aside>

Expand Down Expand Up @@ -1712,8 +1574,6 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<li><a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_getUrl">getUrl()</a></li>
<li><a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_handleError">handleError()</a></li>
<li><a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_makeRequest">makeRequest()</a></li>
<li><a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_createNewResponseError">createNewResponseError()</a></li>
<li><a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_createOldResponseError">createOldResponseError()</a></li>
<li><a href="classes/amcintosh-FreshBooks-Resource-AccountingResource.html#method_rejectMissing">rejectMissing()</a></li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 423cc08

Please sign in to comment.