Delete a service area

use Fetchski\AttractCmsLaravel\Facades\Attract;

Attract::serviceAreas()->deleteServiceArea(id: 'clx8m2k4p0000a1b2c3d4e5f6');

In your app

A controller answers a route on your app: it calls deleteServiceArea() and answers 204 once it is done.

Add the controller

app/Http/Controllers/DeleteServiceAreaController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Http\Response;

final class DeleteServiceAreaController
{
    public function __invoke(string $id): Response
    {
        Attract::serviceAreas()->deleteServiceArea(id: $id);

        return response()->noContent();
    }
}

Add the route

routes/web.php

use App\Http\Controllers\DeleteServiceAreaController;
use Illuminate\Support\Facades\Route;

Route::delete('/service-area/{id}', DeleteServiceAreaController::class)->middleware('auth');

It acts with your key’s access, so auth lets only your signed-in users reach it.

Call it

Your own page’s form or script sends DELETE /service-area/clx8m2k4p0000a1b2c3d4e5f6 (a form adds @csrf, as every web route checks it, and @method('DELETE')), and gets back an empty 204 once it is done. Test it, below, calls it.

To keep the call in an Action instead, this writes app/Actions/Attract/DeleteServiceArea.php (an invokable Action that calls deleteServiceArea()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action serviceAreas.deleteServiceArea

Call it from the terminal

Terminal

php artisan attract:call serviceAreas.deleteServiceArea id=clx8m2k4p0000a1b2c3d4e5f6

It calls deleteServiceArea() on your default site and says when it is done. It writes, so it asks first: add --force to skip the question in a script. See Call any method from the terminal for every argument type.

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.

Laravel

use Fetchski\AttractCmsLaravel\Facades\Attract;

$row = Attract::serviceAreas()->listServiceAreasPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null

Terminal

php artisan attract:call serviceAreas.listServiceAreasPick fields=title,slug

Pass $row['id'] as id. Drafts: list with aposMode: 'draft' to get the draft’s id (Find an id).

Required parameters

Named arguments, e.g. deleteServiceArea(id: …); leave out the optional ones.

string

required

Required. The draft’s _id (…:en:draft): deleting it removes the draft and its published document, for good.

Returns

Nothing (void): the call returns once the site has answered. Deleted, for good (not moved to the archive). No body.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

400

The site refused what was sent: errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().

401

The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage(), errorName(), data().

403

The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage() names it.Retried first: No. Read: siteMessage(), errorName(), data().

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage(), errorName(), data().

500

The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage(), errorName(), data().

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (neverConnected()); never after a timeout, when it may have landed. Read: reason(), neverConnected().

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason() (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason(), status().

setup

Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.

setup

The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (what to fix).

Behavior

Access: an API key with content:service-areas:delete (or a master above it: content:service-areas:all, content:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
Timeout: 15 s per attempt by default; raise timeout in config/fetchski-attract.php for longer.

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/DeleteServiceAreaTest.php, then run your tests:

tests/Feature/DeleteServiceAreaTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

final class DeleteServiceAreaTest extends TestCase
{
    use RefreshDatabase;

    public function test_delete_service_area(): void
    {
        Attract::fake();

        $this->actingAs(User::factory()->create())
            ->deleteJson('/service-area/clx8m2k4p0000a1b2c3d4e5f6')
            ->assertNoContent();

        Attract::assertCalled('serviceAreas.deleteServiceArea', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}

Terminal

php artisan test

List a service area’s locales

Attract::serviceAreas()->getServiceAreaLocales()

List service areas

Attract::serviceAreas()->listServiceAreas()

Create a service area

Attract::serviceAreas()->createServiceArea()

Get a service area

Attract::serviceAreas()->getServiceArea()

Replace a service area

Attract::serviceAreas()->replaceServiceArea()

Update a service area

Attract::serviceAreas()->updateServiceArea()

DELETE /service-area/{_id}

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Find the id

Behavior

Test it

List a service area’s locales

List service areas

Create a service area

Get a service area

Replace a service area

Update a service area

DELETE /service-area/{_id}

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List a service area’s locales

List service areas

Create a service area

Get a service area

Replace a service area

Update a service area

DELETE /service-area/{_id}