Download the PHP package rpwebdevelopment/laravel-blueshift without Composer
On this page you can find all versions of the php package rpwebdevelopment/laravel-blueshift. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rpwebdevelopment/laravel-blueshift
More information about rpwebdevelopment/laravel-blueshift
Files in rpwebdevelopment/laravel-blueshift
Package laravel-blueshift
Short Description Blueshift integration package for laravel
License MIT
Homepage https://github.com/rpwebdevelopment/laravel-blueshift
Informations about the package laravel-blueshift
Blueshift integration package for laravel
This is a Laravel specific package designed to make communication with the Blueshift API quick and easy.
Requirements
Currently this package only functions on Laravel 8.*
Installation
You can install the package via composer:
Usage
Configuration
Before the library can function, it expects the blueshift configuration to be provided This package provides a base version of the configuration which you can install by running
The Base configuration pulls values from the environment (env) to populate the configuration.
BLUESHIFT_API_KEY- This should be the "Users Api Key" provided by BlueshiftBLUESHIFT_BASE_URL- Defaults to 'https://api.eu.getblueshift.com', for non EU this should be set to 'https://api.getblueshift.com'
Class Structure
laravel-blueshift provides specific classes for handling different API endpoints, the available classes and their methods are as follows:
- BlueshiftCustomer
- search(string $email);
- get(string $uuid);
- createJson(string $customer);
- createArray(array $customer);
- bulkCreateJson(string $customers);
- bulkCreateArray(array $customers);
- manageCustomerSubscriptions(?string $email = null, ?string $uuid = null, bool $unsubscribedEmail = false, bool $unsubscribedPush = false, bool $unsubscribedSms = false);
- unsubscribeCustomerFromEmail(?string $email = null, ?string $uuid = null);
- unsubscribeCustomerFromSms(?string $email = null, ?string $uuid = null);
- unsubscribeCustomerFromPush(?string $email = null, ?string $uuid = null);
- unsubscribeCustomerFromAll(?string $email = null, ?string $uuid = null);
- manageEmailListSubscriptions(array $emailList, ?bool $unsubscribedEmail = null, ?bool $unsubscribedPush = null, ?bool $unsubscribedSms = null);
- startTracking(?string $email, ?string $uuid);
- stopTracking(?string $email, ?string $uuid);
- delete(?string $email, ?string $uuid, bool $allMatching)
- BlueshiftCatalog
- createCatalog(string $name);
- getList();
- addItems(string $uuid, array $items);
- getCatalog(string $uuid);
- BlueshiftUserList
- createList(string $name, string $description, string $source = 'email');
- addUserToList(int $listId, string $identifierKey, string $identifierValue);
- removeUserFromList(int $listId, string $identifierKey, string $identifierValue);
- BlueshiftEvent
- sendEvent(array $event);
From your laravel application these methods can be called as follows:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-blueshift with dependencies
ext-curl Version *
guzzlehttp/guzzle Version ^7.0
illuminate/contracts Version ^8.53
spatie/laravel-package-tools Version ^1.9.2
ext-json Version *