Giter VIP home page Giter VIP logo

laravel-aimtell's Introduction

Laravel Aimtell Package

Latest Version on Packagist GitHub Tests Action Status Total Downloads

Aimtell offers a service for push notifications to users who give permission. This package allows for interfacing with Aimtell's backend API to manage your account.

Aimtell REST API Documentation

Installation

You can install the package via composer:

composer require collinped/laravel-aimtell

You can publish and run the migrations with:

You can publish the config file with:

php artisan vendor:publish --provider="Collinped\LaravelAimtell\AimtellServiceProvider" --tag="config"

This is the contents of the published config file:

return [
    'api_key' => env('AIMTELL_API_KEY'), // Required - API Key Provided by Aimtell
    'default_site_id' => env('AIMTELL_DEFAULT_SITE_ID'), // Recommended
    'white_label_id' => env('AIMTELL_WHITE_LABEL_ID'), // Must contact Aimtell for White Label ID
];

Usage

Quick Example

$site = aimtell()->site()
                ->create([
                    'name' => 'Sample Website',
                    'url' => 'collinped.com'
                ]);

$campaigns = aimtell()->site($siteId)
                     ->campaign()
                     ->all();

$campaign = aimtell()->site($siteId)
                    ->campaign()
                    ->find($campaignId);

Testing

composer test

Todo

  • A/B Tests for Manual Campaigns
  • Create Manual Campaign (Batch)
  • Update Manual Campaign (Batch)
  • Delete Manual Campaign (Batch)
  • Create Event Triggered Campaign (Batch)
  • Update Event Triggered Campaign (Batch)
  • Delete Event Triggered Campaign (Batch)
  • Get Notification Logs
  • Get Attributes Logs
  • Get Pageview Logs
  • Get Event Logs

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

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.

laravel-aimtell's People

Contributors

chrisob120 avatar collinped avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.