rulecom/api-wrapper

Api wrapper for the RULE mailer.

v1.0.11 2023-08-17 10:40 UTC

Requires

• guzzlehttp/guzzle: >=6.2

Requires (Dev)

• cvuorinen/phpdoc-markdown-public: *
• monolog/monolog: 1.*
• phpdocumentor/phpdocumentor: ~2.8
• phpspec/phpspec: ^2.5
• phpunit/phpunit: ^5.4

MIT

• Stanislav Kalashnik
• Ivan Shamota

README

Package wrapping an RULE Mailer api using an guzzlehttp client as backend for the requests

Installation

Regular composer installation supposed, like: composer require rulecom/api-wrapper

Integration with Laravel

Use src/LaravelServiceProvider.php to register API instances in your application. Create config/rule-api.php file for the API configuration.

Then you'll be able to disectly use configured API classes

use Rule\ApiWrapper\Api\V2\Subscriber\Subscriber;

class Foo
{
    private $subscriberApi;

    public function __construct(Subscriber $subscriberApi)
    {
        $this->subscriberApi = $subscriberApi;
    }

    public function createMeSomeSubscriber($params)
    {
        //... do something 
        $this->subscriberApi->create([
            'email' => $email,
            //... see docs for detailes
        ]);
    }
}

Docs

For the docs please refer docs folder in this repository.