ENG-2608 - New APIs/method overloads (#51)

* capture current cli state

* add report method

* let's run on all PRs

* forgot PHP

* test/issue 1

* revert overloads

* test fixes

* client correct/optional

* now that this overload does not have opt params, remove defaults

Author: wied03

.github/workflows/test.yaml

@@ -5,8 +5,6 @@ on:
     branches:
       - main
   pull_request:
-    branches:
-      - main
   workflow_dispatch:
 
 permissions:
@@ -16,31 +14,31 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up FusionAuth
-      working-directory: .github/fusionauth
-      run: docker compose up -d
-
-    - name: Validate composer.json and composer.lock
-      run: |
-        composer update
-        composer validate
-
-    - name: Cache Composer packages
-      id: composer-cache
-      uses: actions/cache@v4
-      with:
-        path: vendor
-        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-php-
-
-    - name: Install dependencies
-      run: composer install --prefer-dist --no-progress
-
-    - name: Waiting for FusionAuth App
-      run: timeout 30 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:9011)" != "200" ]]; do sleep 5; done' || false
-
-    - name: Run test suite
-      run: composer run test
+      - uses: actions/checkout@v4
+
+      - name: Set up FusionAuth
+        working-directory: .github/fusionauth
+        run: docker compose up -d
+
+      - name: Validate composer.json and composer.lock
+        run: |
+          composer update
+          composer validate
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v4
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Waiting for FusionAuth App
+        run: timeout 30 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:9011)" != "200" ]]; do sleep 5; done' || false
+
+      - name: Run test suite
+        run: composer run test

src/FusionAuth/FusionAuthClient.php

@@ -4392,6 +4392,24 @@ public function retrieveUserByLoginId($loginId)
         ->go();
   }
 
+  /**
+   * Retrieves the user for the loginId, using specific loginIdTypes.
+   *
+   * @param string $loginId The email or username of the user.
+   * @param array $loginIdTypes the identity types that FusionAuth will compare the loginId to.
+   *
+   * @return ClientResponse The ClientResponse.
+   * @throws \Exception
+   */
+  public function retrieveUserByLoginIdWithLoginIdTypes($loginId, $loginIdTypes)
+  {
+    return $this->start()->uri("/api/user")
+        ->urlParameter("loginId", $loginId)
+        ->urlParameter("loginIdTypes", $loginIdTypes)
+        ->get()
+        ->go();
+  }
+
   /**
    * Retrieves the user for the given username.
    *
@@ -4621,6 +4639,31 @@ public function retrieveUserLoginReportByLoginId($applicationId, $loginId, $star
         ->go();
   }
 
+  /**
+   * Retrieves the login report between the two instants for a particular user by login Id, using specific loginIdTypes. 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 array $start The start instant as UTC milliseconds since Epoch.
+   * @param array $end The end instant as UTC milliseconds since Epoch.
+   * @param array $loginIdTypes the identity types that FusionAuth will compare the loginId to.
+   *
+   * @return ClientResponse The ClientResponse.
+   * @throws \Exception
+   */
+  public function retrieveUserLoginReportByLoginIdAndLoginIdTypes($applicationId, $loginId, $start, $end, $loginIdTypes)
+  {
+    return $this->start()->uri("/api/report/login")
+        ->urlParameter("applicationId", $applicationId)
+        ->urlParameter("loginId", $loginId)
+        ->urlParameter("start", $start)
+        ->urlParameter("end", $end)
+        ->urlParameter("loginIdTypes", $loginIdTypes)
+        ->get()
+        ->go();
+  }
+
   /**
    * Retrieves the last number of login records for a user.
    *

tests/FusionAuth/FusionAuthClientTest.php

@@ -118,6 +118,21 @@ public function testCanHandleUsers(): void
         $this->handleResponse($response);
         $this->assertEquals("test@fusionauth.io", $response->successResponse->user->email);
 
+        // retrieve by login Id (default types)
+        $response = $this->client->retrieveUserByLoginId("test@fusionauth.io");
+        $this->handleResponse($response);
+        $this->assertEquals("test@fusionauth.io", $response->successResponse->user->email);
+
+        // retrieve by login Id (explicit types)
+        $response = $this->client->retrieveUserByLoginIdWithLoginIdTypes("test@fusionauth.io", ["email"]);
+        $this->handleResponse($response);
+        $this->assertEquals("test@fusionauth.io", $response->successResponse->user->email);
+
+        // retrieve by login Id (not found, wrong type)
+// TODO: will pass once issue 1 is live
+//         $response = $this->client->retrieveUserByLoginIdWithLoginIdTypes("test@fusionauth.io", ["phoneNumber"]);
+//         $this->assertEquals(404, $response->status);
+
         // Login
         $response = $this->client->login(["loginId" => "test@fusionauth.io", "password" => "password"]);
         $this->handleResponse($response);