getsendstack / laravel-sendstack
A Laravel Package to work with the SendStack API
1.0.0
2023-05-24 09:39 UTC
Requires
- php: ^8.1
- illuminate/contracts: ^9.25|^10.0
- juststeveking/http-status-code: ^3.0
- juststeveking/laravel-data-object-tools: ^1.0
Requires (Dev)
- guzzlehttp/guzzle: ^7.4
- laravel/pint: ^1.1
- nunomaduro/larastan: ^2.1
- orchestra/testbench: ^7.0|^8.0
- pestphp/pest: ^1.21|^2.0
README
Installation
You can install the package via composer:
composer require getsendstack/laravel-sendstack
You can publish the config file with:
php artisan vendor:publish --tag="sendstack-config"
Set up
To start using this package, you need to add environment variables for:
SENDSTACK_URL
- Optional, not really needed as this has a defaultSENDSTACK_TOKEN
- You can generate this from your getSendStack account.
The package will pick these up in its configuration and use these when it resolves an instance of the Client
.
Usage
This package can be used by injecting the SendStack\Laravel\Http\Client
into a method to instantiate the client:
declare(strict_types=1); use App\Models\Subscriber; use Illuminate\Bus\Queueable; use Illuminate\Contracts\Queue\ShouldQueue; use Illuminate\Foundation\Bus\Dispatchable; use Illuminate\Queue\InteractsWithQueue; use Illuminate\Queue\SerializesModels; use SendStack\Laravel\Contracts\ClientContract; namespace App\Jobs\SendStack; class SyncSubscribers implements ShouldQueue { use Queueable; use Dispatchable; use SerializesModels; use InteractsWithQueue; public function handle(ClientContract $client): void { foreach ($client->subscribers()->all() as $subscriber) { Subscriber::query()->updateOrCreate( attributes: ['email' => $subscriber->email], values: $subscriber->toArray(), ); } } }
Alternatively you can use the Facade to help you:
declare(strict_types=1); use App\Models\Subscriber; use Illuminate\Bus\Queueable; use Illuminate\Contracts\Queue\ShouldQueue; use Illuminate\Foundation\Bus\Dispatchable; use Illuminate\Queue\InteractsWithQueue; use Illuminate\Queue\SerializesModels; use SendStack\Laravel\Facades\SendStack; namespace App\Jobs\SendStack; class SyncSubscribers implements ShouldQueue { use Queueable; use Dispatchable; use SerializesModels; use InteractsWithQueue; public function handle(): void { foreach (SendStack::subscribers()->all() as $subscriber) { Subscriber::query()->updateOrCreate( attributes: ['email' => $subscriber->email], values: $subscriber->toArray(), ); } } }
Getting a list of Subscribers
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->subscribers()->all(); /** * Using the Facade */ SendStack::subscribers()->all();
Getting a single Subscriber
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->subscribers()->get( query: '1234-1234-1234-1234' // This can be either the subscribers UUID or their Email Address ); /** * Using the Facade */ SendStack::subscribers()->get( query: '1234-1234-1234-1234', // This can be either the subscribers UUID or their Email Address );
Creating a new Subscriber
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; use SendStack\Laravel\Http\Requests\SubscriberRequest; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->subscribers()->create( request: new SubscriberRequest( email: 'contact@getsendstack.com', // Required firstName: 'Send', // Optional lastName: 'Stack', // Optional tags: [ 'Client', 'Awesome', ], // Optional optIn: true, // Optional ), ); /** * Using the Facade */ SendStack::subscribers()->create( request: new SubscriberRequest( email: 'contact@getsendstack.com', // Required firstName: 'Send', // Optional lastName: 'Stack', // Optional tags: [ 'Client', 'Awesome', ], // Optional optIn: true, // Optional ), );
Update a Subscriber
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; use SendStack\Laravel\Http\Requests\SubscriberRequest; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->subscribers()->update( uuid: '1234-1234-1234-1234', request: new SubscriberRequest( email: 'contact@getsendstack.com', // Required firstName: 'Send', // Optional lastName: 'Stack', // Optional tags: [ 'Client', 'Awesome', ], // Optional optIn: true, // Optional ), ); /** * Using the Facade */ SendStack::subscribers()->update( uuid: '1234-1234-1234-1234', request: new SubscriberRequest( email: 'contact@getsendstack.com', // Required firstName: 'Send', // Optional lastName: 'Stack', // Optional tags: [ 'Client', 'Awesome', ], // Optional optIn: true, // Optional ), );
Deleting a Subscriber
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->subscribers()->delete( uuid: '1234-1234-1234-1234' ); /** * Using the Facade */ SendStack::subscribers()->delete( uuid: '1234-1234-1234-1234', );
Attaching a Tag to a Subscriber
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->subscribers()->attachTag( uuid: '1234-1234-1234-1234', tag: 'Early Access', ); /** * Using the Facade */ SendStack::subscribers()->attachTag( uuid: '1234-1234-1234-1234', tag: 'Early Access', );
Removing a Tag from a Subscriber
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->subscribers()->removeTag( uuid: '1234-1234-1234-1234', tag: 'Early Access', ); /** * Using the Facade */ SendStack::subscribers()->removeTag( uuid: '1234-1234-1234-1234', tag: 'Early Access', );
Checking if an email address is an Active Subscriber
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->isActiveSubscriber( email: 'taylor@laravel.com', ); /** * Using the Facade */ SendStack::isActiveSubscriber( email: 'taylor@laravel.com', );
Getting all Tags
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->tags()->all(); /** * Using the Facade */ SendStack::tags()->all();
Creating a new Tag
use SendStack\Laravel\Contracts\ClientContract; use SendStack\Laravel\Facades\SendStack; use SendStack\Laravel\Http\Requests\TagRequest; /** * Without a Facade */ $client = app()->make( abstract: ClientContract::class, ); $client->tags()->create( request: new TagRequest( name: 'Test', // Required allowFormSubscription: true, // Optional ), ); /** * Using the Facade */ SendStack::tags()->create( request: new TagRequest( name: 'Test', // Required allowFormSubscription: true, // Optional ), );
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.