plutolinks/loops

v0.2.0 2024-05-18 13:40 UTC

Requires

• php: ^8.1
• saloonphp/saloon: ^3.7
• thecodingmachine/safe: ^2.5

Requires (Dev)

• ergebnis/composer-normalize: ^2.42
• laravel/pint: ^1.14
• pestphp/pest: ^2.34
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• rector/rector: ^1.0
• spaze/phpstan-disallowed-calls: ^3.1
• thecodingmachine/phpstan-safe-rule: ^1.2

MIT

• Hosmel Quintana

• php
• email
• marketing
• transactional
• loops
• plutolinks

README

Introduction

The Loops PHP SDK provides an expressive interface for interacting with Loops's API.

Requirements

Requires PHP 8.1+

Installation

You may install Loops into your project using the Composer package manager:

composer require plutolinks/loops

Usage

You can create an instance of the SDK like so:

use PlutoLinks\Loops\Loops;

$loops = Loops::client('<api-key>'); 

Contacts

Create a new contact

$response = $loops->contacts()->create([
    'email' => '[e-mail]',
    'firstName' => 'John',
]);

You can access the properties of the response:

$response->success;
$response->id;
$response->message;

API Reference

Retrieve a contact

$contact = $loops->contacts()->retrieve('[e-mail]');

You can access the properties of the contact:

$contact->email;
$contact->firstName;
$contact->id;
$contact->lastName;
$contact->source;
$contact->subscribed;
$contact->userGroup;
$contact->userId;

$contact->favoriteColor; // Custom property

API Reference

Update a contact

$response = $loops->contacts()->update('[e-mail]', [
    'firstName' => 'John',
]);

You can access the properties of the response:

$response->success;
$response->id;
$response->message;

API Reference

Delete a contact

$loops->contacts()->delete(email: '[e-mail]');

Alternatively, you can delete a contact by its userId:

$loops->contacts()->delete(userId: 'asdf');

You can access the properties of the response:

$response->message;
$response->success;

API Reference

Custom fields

$fields = $loops->contacts()->customFields();

You can access the properties of the response:

foreach ($fields as $field) {
    $field->key;
    $field->label;
    $field->type;
}

API Reference

Events

Send event

$response = $loops->events()->send(
    eventName: 'signup',
    email: '[e-mail]',
    properties: [
        'firstName' => 'John',
    ]
);

You can access the properties of the response:

$response->success;
$response->message;

API Reference

Transactional emails

Send transactional email

$response = $loops->transactional()->send(
    transactionalId: 'asdf',
    email: '[e-mail]',
    dataVariables: [
        'url' => 'https://example.com',
    ],
    attachments: [
        [
            'contentType' => 'application/pdf', 
            'data' => '/9j/4AAQSkZJRgABAQEASABIAAD/4...', 
            'filename' => 'file.pdf', 
        ],
    ]
);

You can access the properties of the response:

$response->success;
$response->error;
$response->message;
$response->path;
$response->transactionalId;

It's necessary to check for errors in different places due to the difference error responses from the Loops API.

API Reference

Credits

• Hosmel Quintana
• All Contributors

License

The MIT License (MIT). Please see License File for more information.