Skip to content

Commit

Permalink
📝 Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@andrewpai
andrewpai committed Oct 25, 2024
1 parent 64263fb commit e102d1c
Show file tree
Hide file tree
Showing 11 changed files with 393 additions and 124 deletions.
12 changes: 6 additions & 6 deletions docs/classes/FusionAuth-ClientResponse.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -622,12 +622,12 @@ <h4 class="phpdocumentor-element__name" id="method_wasSuccessful">
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_errorResponse">$errorResponse</li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_exception">$exception</li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_method">$method</li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_request">$request</li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_status">$status</li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_successResponse">$successResponse</li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_errorResponse">$errorResponse</a></li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_exception">$exception</a></li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_method">$method</a></li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_request">$request</a></li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_status">$status</a></li>
<li class=""><a href="classes/FusionAuth-ClientResponse.html#property_successResponse">$successResponse</a></li>
</ul>
</li>

Expand Down
4 changes: 2 additions & 2 deletions docs/classes/FusionAuth-FormDataBodyHandler.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -584,8 +584,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/FusionAuth-FormDataBodyHandler.html#property_body">$body</li>
<li class=""><a href="classes/FusionAuth-FormDataBodyHandler.html#property_bodyObject">$bodyObject</li>
<li class=""><a href="classes/FusionAuth-FormDataBodyHandler.html#property_body">$body</a></li>
<li class=""><a href="classes/FusionAuth-FormDataBodyHandler.html#property_bodyObject">$bodyObject</a></li>
</ul>
</li>

Expand Down
418 changes: 326 additions & 92 deletions docs/classes/FusionAuth-FusionAuthClient.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/FusionAuth-JSONBodyHandler.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -584,8 +584,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/FusionAuth-JSONBodyHandler.html#property_body">$body</li>
<li class=""><a href="classes/FusionAuth-JSONBodyHandler.html#property_bodyObject">$bodyObject</li>
<li class=""><a href="classes/FusionAuth-JSONBodyHandler.html#property_body">$body</a></li>
<li class=""><a href="classes/FusionAuth-JSONBodyHandler.html#property_bodyObject">$bodyObject</a></li>
</ul>
</li>

Expand Down
24 changes: 12 additions & 12 deletions docs/classes/FusionAuth-RESTClient.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1835,18 +1835,18 @@ <h4 class="phpdocumentor-element__name" id="method_resetAuthorizationHeaders">
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_bodyHandler">$bodyHandler</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_certificate">$certificate</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_connectTimeout">$connectTimeout</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_errorResponseHandler">$errorResponseHandler</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_headers">$headers</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_key">$key</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_method">$method</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_parameters">$parameters</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_proxy">$proxy</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_readTimeout">$readTimeout</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_successResponseHandler">$successResponseHandler</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_url">$url</li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_bodyHandler">$bodyHandler</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_certificate">$certificate</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_connectTimeout">$connectTimeout</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_errorResponseHandler">$errorResponseHandler</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_headers">$headers</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_key">$key</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_method">$method</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_parameters">$parameters</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_proxy">$proxy</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_readTimeout">$readTimeout</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_successResponseHandler">$successResponseHandler</a></li>
<li class=""><a href="classes/FusionAuth-RESTClient.html#property_url">$url</a></li>
</ul>
</li>

Expand Down
6 changes: 3 additions & 3 deletions docs/classes/Tests-FusionAuthClientTest.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -842,9 +842,9 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_applicationId">$applicationId</li>
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_client">$client</li>
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_userId">$userId</li>
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_applicationId">$applicationId</a></li>
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_client">$client</a></li>
<li class=""><a href="classes/Tests-FusionAuthClientTest.html#property_userId">$userId</a></li>
</ul>
</li>

Expand Down
3 changes: 3 additions & 0 deletions docs/css/template.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,3 +280,6 @@
.phpdocumentor-title__link:hover {
transform: none;
}
.phpdocumentor-uml-diagram svg {
cursor: zoom-in;
}
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<title>FusionAuth PHP Client</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">
Expand Down
15 changes: 15 additions & 0 deletions docs/js/searchIndex.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1345,6 +1345,16 @@ Search.appendIndex(
"name": "retrieveWebhook",
"summary": "Retrieves\u0020the\u0020webhook\u0020for\u0020the\u0020given\u0020Id.\u0020If\u0020you\u0020pass\u0020in\u0020null\u0020for\u0020the\u0020id,\u0020this\u0020will\u0020return\u0020all\u0020the\u0020webhooks.",
"url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveWebhook"
}, {
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveWebhookAttemptLog\u0028\u0029",
"name": "retrieveWebhookAttemptLog",
"summary": "Retrieves\u0020a\u0020single\u0020webhook\u0020attempt\u0020log\u0020for\u0020the\u0020given\u0020Id.",
"url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveWebhookAttemptLog"
}, {
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveWebhookEventLog\u0028\u0029",
"name": "retrieveWebhookEventLog",
"summary": "Retrieves\u0020a\u0020single\u0020webhook\u0020event\u0020log\u0020for\u0020the\u0020given\u0020Id.",
"url": "classes/FusionAuth-FusionAuthClient.html#method_retrieveWebhookEventLog"
}, {
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AretrieveWebhooks\u0028\u0029",
"name": "retrieveWebhooks",
Expand Down Expand Up @@ -1505,6 +1515,11 @@ Search.appendIndex(
"name": "searchUsersByQueryString",
"summary": "Retrieves\u0020the\u0020users\u0020for\u0020the\u0020given\u0020search\u0020criteria\u0020and\u0020pagination.",
"url": "classes/FusionAuth-FusionAuthClient.html#method_searchUsersByQueryString"
}, {
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AsearchWebhookEventLogs\u0028\u0029",
"name": "searchWebhookEventLogs",
"summary": "Searches\u0020the\u0020webhook\u0020event\u0020logs\u0020with\u0020the\u0020specified\u0020criteria\u0020and\u0020pagination.",
"url": "classes/FusionAuth-FusionAuthClient.html#method_searchWebhookEventLogs"
}, {
"fqsen": "\\FusionAuth\\FusionAuthClient\u003A\u003AsearchWebhooks\u0028\u0029",
"name": "searchWebhooks",
Expand Down
17 changes: 17 additions & 0 deletions docs/js/template.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,20 @@
observer.observe(el);
})
})();
function openSvg(svg) {
// convert to a valid XML source
const as_text = new XMLSerializer().serializeToString(svg);
// store in a Blob
const blob = new Blob([as_text], { type: "image/svg+xml" });
// create an URI pointing to that blob
const url = URL.createObjectURL(blob);
const win = open(url);
// so the Garbage Collector can collect the blob
win.onload = (evt) => URL.revokeObjectURL(url);
};


var svgs = document.querySelectorAll(".phpdocumentor-uml-diagram svg");
for( var i=0,il = svgs.length; i< il; i ++ ) {
svgs[i].onclick = (evt) => openSvg(evt.target);
}
12 changes: 6 additions & 6 deletions docs/reports/deprecated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,37 +124,37 @@ <h3><abbr title="src/FusionAuth/FusionAuthClient.php">FusionAuthClient.php</abbr
</td>
</tr>
<tr>
<td class="phpdocumentor-cell">5080</td>
<td class="phpdocumentor-cell">5112</td>
<td class="phpdocumentor-cell"><a href="classes/FusionAuth-FusionAuthClient.html#method_searchUsers"><abbr title="\FusionAuth\FusionAuthClient::searchUsers()">FusionAuthClient::searchUsers()</abbr></a></td>
<td class="phpdocumentor-cell"><p>This method has been renamed to searchUsersByIds, use that method instead.</p>
</td>
</tr>
<tr>
<td class="phpdocumentor-cell">5131</td>
<td class="phpdocumentor-cell">5163</td>
<td class="phpdocumentor-cell"><a href="classes/FusionAuth-FusionAuthClient.html#method_searchUsersByQueryString"><abbr title="\FusionAuth\FusionAuthClient::searchUsersByQueryString()">FusionAuthClient::searchUsersByQueryString()</abbr></a></td>
<td class="phpdocumentor-cell"><p>This method has been renamed to searchUsersByQuery, use that method instead.</p>
</td>
</tr>
<tr>
<td class="phpdocumentor-cell">5215</td>
<td class="phpdocumentor-cell">5263</td>
<td class="phpdocumentor-cell"><a href="classes/FusionAuth-FusionAuthClient.html#method_sendTwoFactorCode"><abbr title="\FusionAuth\FusionAuthClient::sendTwoFactorCode()">FusionAuthClient::sendTwoFactorCode()</abbr></a></td>
<td class="phpdocumentor-cell"><p>This method has been renamed to sendTwoFactorCodeForEnableDisable, use that method instead.</p>
</td>
</tr>
<tr>
<td class="phpdocumentor-cell">5248</td>
<td class="phpdocumentor-cell">5296</td>
<td class="phpdocumentor-cell"><a href="classes/FusionAuth-FusionAuthClient.html#method_sendTwoFactorCodeForLogin"><abbr title="\FusionAuth\FusionAuthClient::sendTwoFactorCodeForLogin()">FusionAuthClient::sendTwoFactorCodeForLogin()</abbr></a></td>
<td class="phpdocumentor-cell"><p>This method has been renamed to sendTwoFactorCodeForLoginUsingMethod, use that method instead.</p>
</td>
</tr>
<tr>
<td class="phpdocumentor-cell">6010</td>
<td class="phpdocumentor-cell">6058</td>
<td class="phpdocumentor-cell"><a href="classes/FusionAuth-FusionAuthClient.html#method_verifyEmail"><abbr title="\FusionAuth\FusionAuthClient::verifyEmail()">FusionAuthClient::verifyEmail()</abbr></a></td>
<td class="phpdocumentor-cell"><p>This method has been renamed to verifyEmailAddress and changed to take a JSON request body, use that method instead.</p>
</td>
</tr>
<tr>
<td class="phpdocumentor-cell">6066</td>
<td class="phpdocumentor-cell">6114</td>
<td class="phpdocumentor-cell"><a href="classes/FusionAuth-FusionAuthClient.html#method_verifyRegistration"><abbr title="\FusionAuth\FusionAuthClient::verifyRegistration()">FusionAuthClient::verifyRegistration()</abbr></a></td>
<td class="phpdocumentor-cell"><p>This method has been renamed to verifyUserRegistration and changed to take a JSON request body, use that method instead.</p>
</td>
Expand Down

0 comments on commit e102d1c

Please sign in to comment.