merge unverified-children to master

Author: robotdan

src/FusionAuth/FusionAuthClient.php

@@ -548,6 +548,27 @@ public function deactivateUsers($userIds)
   {
     return $this->start()->uri("/api/user/bulk")
         ->urlParameter("userId", $userIds)
+        ->urlParameter("dryRun", false)
+        ->urlParameter("hardDelete", false)
+        ->delete()
+        ->go();
+  }
+
+  /**
+   * Deactivates the users found with the given search query string.
+   *
+   * @param string $queryString The search query string.
+   * @param boolean $dryRun Whether to preview or deactivate the users found by the queryString
+   *
+   * @return ClientResponse The ClientResponse.
+   * @throws \Exception
+   */
+  public function deactivateUsersByQuery($queryString, $dryRun)
+  {
+    return $this->start()->uri("/api/user/bulk")
+        ->urlParameter("queryString", $queryString)
+        ->urlParameter("dryRun", $dryRun)
+        ->urlParameter("hardDelete", false)
         ->delete()
         ->go();
   }
@@ -807,9 +828,11 @@ public function deleteUserActionReason($userActionReasonId)
   }
 
   /**
-   * Deletes the users with the given ids.
+   * Deletes the users with the given ids, or users matching the provided queryString.
+   * If you provide both userIds and queryString, the userIds will be honored.  This can be used to deactivate or hard-delete 
+   * a user based on the hardDelete request body parameter.
    *
-   * @param array $request The ids of the users to delete.
+   * @param array $request The UserDeleteRequest.
    *
    * @return ClientResponse The ClientResponse.
    * @throws \Exception
@@ -822,6 +845,25 @@ public function deleteUsers($request)
         ->go();
   }
 
+  /**
+   * Delete the users found with the given search query string.
+   *
+   * @param string $queryString The search query string.
+   * @param boolean $dryRun Whether to preview or delete the users found by the queryString
+   *
+   * @return ClientResponse The ClientResponse.
+   * @throws \Exception
+   */
+  public function deleteUsersByQuery($queryString, $dryRun)
+  {
+    return $this->start()->uri("/api/user/bulk")
+        ->urlParameter("queryString", $queryString)
+        ->urlParameter("dryRun", $dryRun)
+        ->urlParameter("hardDelete", true)
+        ->delete()
+        ->go();
+  }
+
   /**
    * Deletes the webhook for the given Id.
    *