Skip to content

ENG-2805: generated code for client libraries #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robotdan merged 1 commit into from
Jul 18, 2025
Merged

ENG-2805: generated code for client libraries #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 49 additions & 49 deletions src/FusionAuth/FusionAuthClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace FusionAuth;

/*
* Copyright (c) 2018-2023, FusionAuth, All Rights Reserved
* Copyright (c) 2018-2025, FusionAuth, All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -973,7 +973,7 @@ public function deactivateUserAction($userActionId)
}

/**
* Deactivates the users with the given ids.
* Deactivates the users with the given Ids.
*
* @param array $userIds The ids of the users to deactivate.
*
Expand All @@ -992,7 +992,7 @@ public function deactivateUsers($userIds)
}

/**
* Deactivates the users with the given ids.
* Deactivates the users with the given Ids.
*
* @param array $userIds The ids of the users to deactivate.
*
Expand Down Expand Up @@ -1566,8 +1566,8 @@ public function deleteUserWithRequest($userId, $request)
}

/**
* Deletes the users with the given ids, or users matching the provided JSON query or queryString.
* The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.
* Deletes the users with the given Ids, or users matching the provided JSON query or queryString.
* The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request.
*
* This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
* Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
Expand All @@ -1587,8 +1587,8 @@ public function deleteUsers($request)
}

/**
* Deletes the users with the given ids, or users matching the provided JSON query or queryString.
* The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.
* Deletes the users with the given Ids, or users matching the provided JSON query or queryString.
* The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request.
*
* This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
* Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
Expand Down Expand Up @@ -2237,7 +2237,7 @@ public function lookupIdentityProvider($domain)
* Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the
* action.
*
* @param string $actionId The Id of the action to modify. This is technically the user action log id.
* @param string $actionId The Id of the action to modify. This is technically the user action log Id.
* @param array $request The request that contains all the information about the modification.
*
* @return ClientResponse The ClientResponse.
Expand Down Expand Up @@ -2269,10 +2269,10 @@ public function passwordlessLogin($request)
}

/**
* Updates an authentication API key by given id
* Updates an API key with the given Id.
*
* @param string $keyId The Id of the authentication key. If not provided a secure random api key will be generated.
* @param array $request The request object that contains all the information needed to create the APIKey.
* @param string $keyId The Id of the API key. If not provided a secure random api key will be generated.
* @param array $request The request object that contains all the information needed to create the API key.
*
* @return ClientResponse The ClientResponse.
* @throws \Exception
Expand All @@ -2282,7 +2282,7 @@ public function patchAPIKey($keyId, $request)
return $this->start()->uri("/api/api-key")
->urlSegment($keyId)
->bodyHandler(new JSONBodyHandler($request))
->post()
->patch()
->go();
}

Expand Down Expand Up @@ -2935,7 +2935,7 @@ public function reindex($request)
}

/**
* Removes a user from the family with the given id.
* Removes a user from the family with the given Id.
*
* @param string $familyId The Id of the family to remove the user from.
* @param string $userId The Id of the user to remove from the family.
Expand Down Expand Up @@ -3006,7 +3006,7 @@ public function resendRegistrationVerification($email, $applicationId)
}

/**
* Retrieves an authentication API key for the given id
* Retrieves an authentication API key for the given Id.
*
* @param string $keyId The Id of the API key to retrieve.
*
Expand Down Expand Up @@ -3092,7 +3092,7 @@ public function retrieveActiveActions($userId)
/**
* Retrieves the application for the given Id or all the applications if the Id is null.
*
* @param string $applicationId (Optional) The application id.
* @param string $applicationId (Optional) The application Id.
*
* @return ClientResponse The ClientResponse.
* @throws \Exception
Expand Down Expand Up @@ -3196,10 +3196,10 @@ public function retrieveConsents()
}

/**
* Retrieves the daily active user report between the two instants. If you specify an application id, it will only
* Retrieves the daily active user report between the two instants. If you specify an application Id, it will only
* return the daily active counts for that application.
*
* @param string $applicationId (Optional) The application id.
* @param string $applicationId (Optional) The application Id.
* @param array $start The start instant as UTC milliseconds since Epoch.
* @param array $end The end instant as UTC milliseconds since Epoch.
*
Expand All @@ -3217,7 +3217,7 @@ public function retrieveDailyActiveReport($applicationId, $start, $end)
}

/**
* Retrieves the email template for the given Id. If you don't specify the id, this will return all the email templates.
* Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
*
* @param string $emailTemplateId (Optional) The Id of the email template.
*
Expand Down Expand Up @@ -3732,10 +3732,10 @@ public function retrieveLambdasByType($type)
}

/**
* Retrieves the login report between the two instants. If you specify an application id, it will only return the
* Retrieves the login report between the two instants. If you specify an application Id, it will only return the
* login counts for that application.
*
* @param string $applicationId (Optional) The application id.
* @param string $applicationId (Optional) The application Id.
* @param array $start The start instant as UTC milliseconds since Epoch.
* @param array $end The end instant as UTC milliseconds since Epoch.
*
Expand All @@ -3753,7 +3753,7 @@ public function retrieveLoginReport($applicationId, $start, $end)
}

/**
* Retrieves the message template for the given Id. If you don't specify the id, this will return all the message templates.
* Retrieves the message template for the given Id. If you don't specify the Id, this will return all the message templates.
*
* @param string $messageTemplateId (Optional) The Id of the message template.
*
Expand Down Expand Up @@ -3829,10 +3829,10 @@ public function retrieveMessengers()
}

/**
* Retrieves the monthly active user report between the two instants. If you specify an application id, it will only
* Retrieves the monthly active user report between the two instants. If you specify an application Id, it will only
* return the monthly active counts for that application.
*
* @param string $applicationId (Optional) The application id.
* @param string $applicationId (Optional) The application Id.
* @param array $start The start instant as UTC milliseconds since Epoch.
* @param array $end The end instant as UTC milliseconds since Epoch.
*
Expand Down Expand Up @@ -4047,7 +4047,7 @@ public function retrieveRefreshTokens($userId)
}

/**
* Retrieves the user registration for the user with the given Id and the given application id.
* Retrieves the user registration for the user with the given Id and the given application Id.
*
* @param string $userId The Id of the user.
* @param string $applicationId The Id of the application.
Expand All @@ -4065,10 +4065,10 @@ public function retrieveRegistration($userId, $applicationId)
}

/**
* Retrieves the registration report between the two instants. If you specify an application id, it will only return
* Retrieves the registration report between the two instants. If you specify an application Id, it will only return
* the registration counts for that application.
*
* @param string $applicationId (Optional) The application id.
* @param string $applicationId (Optional) The application Id.
* @param array $start The start instant as UTC milliseconds since Epoch.
* @param array $end The end instant as UTC milliseconds since Epoch.
*
Expand Down Expand Up @@ -4287,7 +4287,7 @@ public function retrieveUser($userId)
}

/**
* Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user
* Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user
* actions.
*
* @param string $userActionId (Optional) The Id of the user action.
Expand All @@ -4304,7 +4304,7 @@ public function retrieveUserAction($userActionId = NULL)
}

/**
* Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all the user
* Retrieves the user action reason for the given Id. If you pass in null for the Id, this will return all the user
* action reasons.
*
* @param string $userActionReasonId (Optional) The Id of the user action reason.
Expand Down Expand Up @@ -4435,8 +4435,8 @@ public function retrieveUserByVerificationId($verificationId)
*
* This API is useful if you want to build your own login workflow to complete a device grant.
*
* @param string $client_id The client id.
* @param string $client_secret The client id.
* @param string $client_id The client Id.
* @param string $client_secret The client Id.
* @param string $user_code The end-user verification code.
*
* @return ClientResponse The ClientResponse.
Expand Down Expand Up @@ -4581,11 +4581,11 @@ public function retrieveUserLinksByUserId($identityProviderId, $userId)
}

/**
* Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the
* Retrieves the login report between the two instants for a particular user by Id. If you specify an application Id, it will only return the
* login counts for that application.
*
* @param string $applicationId (Optional) The application id.
* @param string $userId The userId id.
* @param string $applicationId (Optional) The application Id.
* @param string $userId The userId Id.
* @param array $start The start instant as UTC milliseconds since Epoch.
* @param array $end The end instant as UTC milliseconds since Epoch.
*
Expand All @@ -4604,11 +4604,11 @@ public function retrieveUserLoginReport($applicationId, $userId, $start, $end)
}

/**
* Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the
* Retrieves the login report between the two instants for a particular user by login Id. If you specify an application Id, it will only return the
* login counts for that application.
*
* @param string $applicationId (Optional) The application id.
* @param string $loginId The userId id.
* @param string $applicationId (Optional) The application Id.
* @param string $loginId The userId Id.
* @param array $start The start instant as UTC milliseconds since Epoch.
* @param array $end The end instant as UTC milliseconds since Epoch.
*
Expand Down Expand Up @@ -4709,7 +4709,7 @@ public function retrieveWebAuthnCredentialsForUser($userId)
}

/**
* Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
* Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
*
* @param string $webhookId (Optional) The Id of the webhook.
*
Expand Down Expand Up @@ -5009,7 +5009,7 @@ public function searchEntities($request)
}

/**
* Retrieves the entities for the given ids. If any Id is invalid, it is ignored.
* Retrieves the entities for the given Ids. If any Id is invalid, it is ignored.
*
* @param array $ids The entity ids to search for.
*
Expand Down Expand Up @@ -5233,7 +5233,7 @@ public function searchUserComments($request)
}

/**
* Retrieves the users for the given ids. If any Id is invalid, it is ignored.
* Retrieves the users for the given Ids. If any Id is invalid, it is ignored.
*
* @param array $ids The user ids to search for.
*
Expand All @@ -5250,9 +5250,9 @@ public function searchUsers($ids)
}

/**
* Retrieves the users for the given ids. If any Id is invalid, it is ignored.
* Retrieves the users for the given Ids. If any Id is invalid, it is ignored.
*
* @param array $ids The user ids to search for.
* @param array $ids The user Ids to search for.
*
* @return ClientResponse The ClientResponse.
* @throws \Exception
Expand Down Expand Up @@ -5333,7 +5333,7 @@ public function searchWebhooks($request)
}

/**
* Send an email using an email template id. You can optionally provide <code>requestData</code> to access key value
* Send an email using an email template Id. You can optionally provide <code>requestData</code> to access key value
* pairs in the email template.
*
* @param string $emailTemplateId The Id for the template.
Expand Down Expand Up @@ -5555,18 +5555,18 @@ public function twoFactorLogin($request)
}

/**
* Updates an API key by given id
* Updates an API key with the given Id.
*
* @param string $apiKeyId The Id of the API key to update.
* @param array $request The request object that contains all the information used to create the API Key.
* @param string $keyId The Id of the API key to update.
* @param array $request The request that contains all the new API key information.
*
* @return ClientResponse The ClientResponse.
* @throws \Exception
*/
public function updateAPIKey($apiKeyId, $request)
public function updateAPIKey($keyId, $request)
{
return $this->start()->uri("/api/api-key")
->urlSegment($apiKeyId)
->urlSegment($keyId)
->bodyHandler(new JSONBodyHandler($request))
->put()
->go();
Expand Down Expand Up @@ -6139,7 +6139,7 @@ public function upsertEntityGrant($entityId, $request)
* If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant.
*
* @param string $user_code The end-user verification code.
* @param string $client_id The client id.
* @param string $client_id The client Id.
*
* @return ClientResponse The ClientResponse.
* @throws \Exception
Expand Down Expand Up @@ -6308,4 +6308,4 @@ private function startAnonymous()
->successResponseHandler(new JSONResponseHandler())
->errorResponseHandler(new JSONResponseHandler());
}
}
}