Skip to content

Commit

Permalink
Domain sync
Browse files Browse the repository at this point in the history
  • Loading branch information
@robotdan
robotdan committed Mar 6, 2024
1 parent 15eb03c commit cdfa530
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions src/FusionAuth/FusionAuthClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public function withTenantId($tenantId) {
* "actioner". Both user ids are required in the request object.
*
* @param array $request The action request that includes all the information about the action being taken including
* the id of the action, any options and the duration (if applicable).
* the Id of the action, any options and the duration (if applicable).
*
* @return ClientResponse The ClientResponse.
* @throws \Exception
Expand All @@ -86,7 +86,7 @@ public function actionUser($request)
}

/**
* Activates the FusionAuth Reactor using a license id and optionally a license text (for air-gapped deployments)
* Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments)
*
* @param array $request An optional request that contains the license text to activate Reactor (useful for air-gap deployments of FusionAuth).
*
Expand All @@ -102,9 +102,9 @@ public function activateReactor($request)
}

/**
* Adds a user to an existing family. The family id must be specified.
* Adds a user to an existing family. The family Id must be specified.
*
* @param string $familyId The id of the family.
* @param string $familyId The Id of the family.
* @param array $request The request object that contains all the information used to determine which user to add to the family.
*
* @return ClientResponse The ClientResponse.
Expand Down Expand Up @@ -147,7 +147,7 @@ public function approveDevice($client_id, $client_secret, $token, $user_code)
/**
* Cancels the user action.
*
* @param string $actionId The action id of the action to cancel.
* @param string $actionId The action Id of the action to cancel.
* @param array $request The action request that contains the information about the cancellation.
*
* @return ClientResponse The ClientResponse.
Expand Down Expand Up @@ -185,7 +185,7 @@ public function changePassword($changePasswordId, $request)
}

/**
* Changes a user's password using their identity (login id and password). Using a loginId instead of the changePasswordId
* Changes a user's password using their identity (loginId and password). Using a loginId instead of the changePasswordId
* bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword
* method.
*
Expand Down Expand Up @@ -393,7 +393,7 @@ public function createApplication($applicationId, $request)
}

/**
* Creates a new role for an application. You must specify the id of the application you are creating the role for.
* Creates a new role for an application. You must specify the Id of the application you are creating the role for.
* You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated.
*
* @param string $applicationId The Id of the application to create the role on.
Expand Down Expand Up @@ -523,7 +523,7 @@ public function createEntityType($entityTypeId, $request)
}

/**
* Creates a new permission for an entity type. You must specify the id of the entity type you are creating the permission for.
* Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for.
* You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated.
*
* @param string $entityTypeId The Id of the entity type to create the permission on.
Expand All @@ -545,10 +545,10 @@ public function createEntityTypePermission($entityTypeId, $permissionId, $reques
}

/**
* Creates a family with the user id in the request as the owner and sole member of the family. You can optionally specify an id for the
* Creates a family with the user Id in the request as the owner and sole member of the family. You can optionally specify an Id for the
* family, if not provided one will be generated.
*
* @param string $familyId (Optional) The id for the family. If not provided a secure random UUID will be generated.
* @param string $familyId (Optional) The Id for the family. If not provided a secure random UUID will be generated.
* @param array $request The request object that contains all the information used to create the family.
*
* @return ClientResponse The ClientResponse.
Expand Down Expand Up @@ -2242,7 +2242,7 @@ public function patchApplication($applicationId, $request)
}

/**
* Updates, via PATCH, the application role with the given id for the application.
* Updates, via PATCH, the application role with the given Id for the application.
*
* @param string $applicationId The Id of the application that the role belongs to.
* @param string $roleId The Id of the role to update.
Expand Down Expand Up @@ -2441,7 +2441,7 @@ public function patchMessenger($messengerId, $request)
}

/**
* Updates, via PATCH, the registration for the user with the given id and the application defined in the request.
* Updates, via PATCH, the registration for the user with the given Id and the application defined in the request.
*
* @param string $userId The Id of the user whose registration is going to be updated.
* @param array $request The request that contains just the new registration information.
Expand Down Expand Up @@ -2701,7 +2701,7 @@ public function regenerateReactorKeys()
* Registers a user for an application. If you provide the User and the UserRegistration object on this request, it
* will create the user as well as register them for the application. This is called a Full Registration. However, if
* you only provide the UserRegistration object, then the user must already exist and they will be registered for the
* application. The user id can also be provided and it will either be used to look up an existing user or it will be
* application. The user Id can also be provided and it will either be used to look up an existing user or it will be
* used for the newly created User.
*
* @param string $userId (Optional) The Id of the user being registered for the application and optionally created.
Expand Down Expand Up @@ -2742,8 +2742,8 @@ public function reindex($request)
/**
* 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.
* @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.
*
* @return ClientResponse The ClientResponse.
* @throws \Exception
Expand Down Expand Up @@ -2895,7 +2895,7 @@ public function retrieveActiveActions($userId)
}

/**
* Retrieves the application for the given id or all the applications if the id is null.
* Retrieves the application for the given Id or all the applications if the Id is null.
*
* @param string $applicationId (Optional) The application id.
*
Expand Down Expand Up @@ -3291,7 +3291,7 @@ public function retrieveIPAccessControlList($ipAccessControlListId)
}

/**
* Retrieves the identity provider for the given id or all the identity providers if the id is null.
* Retrieves the identity provider for the given Id or all the identity providers if the Id is null.
*
* @param string $identityProviderId The identity provider Id.
*
Expand Down Expand Up @@ -3833,7 +3833,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 Down Expand Up @@ -4509,8 +4509,8 @@ public function retrieveWebhooks()
* - revokeRefreshTokensByUserIdForApplication
*
* @param string $token (Optional) The refresh token to delete.
* @param string $userId (Optional) The user id whose tokens to delete.
* @param string $applicationId (Optional) The application id of the tokens to delete.
* @param string $userId (Optional) The user Id whose tokens to delete.
* @param string $applicationId (Optional) The application Id of the tokens to delete.
*
* @return ClientResponse The ClientResponse.
* @throws \Exception
Expand Down Expand Up @@ -4721,7 +4721,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 @@ -4945,7 +4945,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 @@ -4962,7 +4962,7 @@ 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.
*
Expand Down Expand Up @@ -5032,7 +5032,7 @@ public function searchWebhooks($request)
* 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.
* @param string $emailTemplateId The Id for the template.
* @param array $request The send email request that contains all the information used to send the email.
*
* @return ClientResponse The ClientResponse.
Expand Down Expand Up @@ -5287,7 +5287,7 @@ public function updateApplication($applicationId, $request)
}

/**
* Updates the application role with the given id for the application.
* Updates the application role with the given Id for the application.
*
* @param string $applicationId The Id of the application that the role belongs to.
* @param string $roleId The Id of the role to update.
Expand Down Expand Up @@ -5398,7 +5398,7 @@ public function updateEntityType($entityTypeId, $request)
}

/**
* Updates the permission with the given id for the entity type.
* Updates the permission with the given Id for the entity type.
*
* @param string $entityTypeId The Id of the entityType that the permission belongs to.
* @param string $permissionId The Id of the permission to update.
Expand Down Expand Up @@ -5613,7 +5613,7 @@ public function updateMessenger($messengerId, $request)
}

/**
* Updates the registration for the user with the given id and the application defined in the request.
* Updates the registration for the user with the given Id and the application defined in the request.
*
* @param string $userId The Id of the user whose registration is going to be updated.
* @param array $request The request that contains all the new registration information.
Expand Down Expand Up @@ -5856,7 +5856,7 @@ public function vendJWT($request)
/**
* Confirms a email verification. The Id given is usually from an email sent to the user.
*
* @param string $verificationId The email verification id sent to the user.
* @param string $verificationId The email verification Id sent to the user.
*
* @return ClientResponse The ClientResponse.
* @throws \Exception
Expand Down

0 comments on commit cdfa530

Please sign in to comment.