Add deleteSubAccount for organization sub-accounts

README.md

@@ -274,6 +274,7 @@ Email marketing:
 General API:
 - Templates CRUD – [`templates/all.php`](examples/templates/all.php)
 - API tokens CRUD – [`api-tokens/all.php`](examples/api-tokens/all.php)
+- Sub-accounts (list, create, delete) – [`sub-accounts/all.php`](examples/sub-accounts/all.php)
 - Billing info – [`general/billing.php`](examples/general/billing.php)
 - Accounts info – [`general/accounts.php`](examples/general/accounts.php)
 - Permissions listing – [`general/permissions.php`](examples/general/permissions.php)

examples/README.md

@@ -73,6 +73,7 @@ Central index of runnable example scripts demonstrating Mailtrap PHP SDK feature
 | Purpose | File |
 |---------|------|
 | API tokens CRUD | [`api-tokens/all.php`](api-tokens/all.php) |
+| Sub-accounts (list, create, delete) | [`sub-accounts/all.php`](sub-accounts/all.php) |
 | Accounts info | [`general/accounts.php`](general/accounts.php) |
 | Billing info | [`general/billing.php`](general/billing.php) |
 | Permissions listing | [`general/permissions.php`](general/permissions.php) |

examples/sub-accounts/all.php

@@ -6,7 +6,7 @@
 
 require __DIR__ . '/../../vendor/autoload.php';
 
-$organizationId = $_ENV['MAILTRAP_ORGANIZATION_ID'];
+$organizationId = (int) $_ENV['MAILTRAP_ORGANIZATION_ID'];
 $config = new Config($_ENV['MAILTRAP_API_KEY']); #your API token from here https://mailtrap.io/api-tokens
 $subAccounts = (new MailtrapGeneralClient($config))->organization($organizationId)->subAccounts();
 
@@ -31,7 +31,27 @@
 try {
     $response = $subAccounts->createSubAccount('My new sub-account');
 
-    var_dump(ResponseHelper::toArray($response));
+    $subAccount = ResponseHelper::toArray($response);
+    $subAccountId = $subAccount['id']; // deleted by the example below
+
+    var_dump($subAccount);
+} catch (Exception $e) {
+    echo 'Caught exception: ',  $e->getMessage(), "\n";
+
+    exit(1); // the example below deletes the sub-account created here
+}
+
+/**
+ * Delete a sub-account from the organization. Requires organization admin permissions.
+ * The deletion is permanent and removes all sub-account data; deleting the organization's last
+ * sub-account also deletes the organization. A repeated call for the same ID returns 404.
+ *
+ * DELETE https://mailtrap.io/api/organizations/{organization_id}/sub_accounts/{sub_account_id}
+ */
+try {
+    $response = $subAccounts->deleteSubAccount($subAccountId);
+
+    echo $response->getStatusCode(); // 204
 } catch (Exception $e) {
     echo 'Caught exception: ',  $e->getMessage(), "\n";
 }

src/Api/General/SubAccount.php

@@ -46,6 +46,24 @@ public function createSubAccount(string $name): ResponseInterface
         );
     }
 
+    /**
+     * Delete a sub-account by ID. Requires organization admin permissions.
+     * The organization must have the Organization & Sub-accounts feature enabled; otherwise the call fails with 403.
+     * The deletion is permanent and removes all sub-account data; deleting the organization's last
+     * sub-account also deletes the organization. A repeated call for the same ID returns 404.
+     * A concurrent deletion of the same sub-account fails with 409.
+     * Rate limit: 10 requests per minute per organization.
+     *
+     * @param int $subAccountId
+     * @return ResponseInterface
+     */
+    public function deleteSubAccount(int $subAccountId): ResponseInterface
+    {
+        return $this->handleResponse(
+            $this->httpDelete($this->getBasePath() . '/' . $subAccountId)
+        );
+    }
+
     public function getOrganizationId(): int
     {
         return $this->organizationId;

tests/Api/General/SubAccountTest.php

@@ -24,7 +24,7 @@ protected function setUp(): void
     {
         parent::setUp();
         $this->subAccount = $this->getMockBuilder(SubAccount::class)
-            ->onlyMethods(['httpGet', 'httpPost'])
+            ->onlyMethods(['httpGet', 'httpPost', 'httpDelete'])
             ->setConstructorArgs([$this->getConfigMock(), self::FAKE_ORGANIZATION_ID])
             ->getMock();
     }
@@ -110,6 +110,54 @@ public function testCreateSubAccountFailsWithValidationError(): void
         $this->subAccount->createSubAccount($invalidName);
     }
 
+    public function testDeleteSubAccount(): void
+    {
+        $subAccountId = 1;
+
+        $this->subAccount->expects($this->once())
+            ->method('httpDelete')
+            ->with(AbstractApi::DEFAULT_HOST . '/api/organizations/' . self::FAKE_ORGANIZATION_ID . '/sub_accounts/' . $subAccountId)
+            ->willReturn(new Response(204));
+
+        $response = $this->subAccount->deleteSubAccount($subAccountId);
+
+        $this->assertEquals(204, $response->getStatusCode());
+    }
+
+    public function testDeleteSubAccountFailsWithForbidden(): void
+    {
+        $subAccountId = 1;
+
+        $this->subAccount->expects($this->once())
+            ->method('httpDelete')
+            ->with(AbstractApi::DEFAULT_HOST . '/api/organizations/' . self::FAKE_ORGANIZATION_ID . '/sub_accounts/' . $subAccountId)
+            ->willReturn(
+                new Response(403, ['Content-Type' => 'application/json'], json_encode(['errors' => 'Access forbidden']))
+            );
+
+        $this->expectException(HttpClientException::class);
+        $this->expectExceptionMessage('Access forbidden');
+
+        $this->subAccount->deleteSubAccount($subAccountId);
+    }
+
+    public function testDeleteSubAccountFailsWithNotFound(): void
+    {
+        $subAccountId = 1;
+
+        $this->subAccount->expects($this->once())
+            ->method('httpDelete')
+            ->with(AbstractApi::DEFAULT_HOST . '/api/organizations/' . self::FAKE_ORGANIZATION_ID . '/sub_accounts/' . $subAccountId)
+            ->willReturn(
+                new Response(404, ['Content-Type' => 'application/json'], json_encode(['error' => 'Not Found']))
+            );
+
+        $this->expectException(HttpClientException::class);
+        $this->expectExceptionMessage('Not Found');
+
+        $this->subAccount->deleteSubAccount($subAccountId);
+    }
+
     private function getExpectedSubAccountResponse(int $id = 1, string $name = 'My sub-account'): array
     {
         return [