README

WARNING: This is not a complete package and is not ready for use. This is a work in progress and only contains a few read only endpoints

A Laravel wrapper of the DealMaker API

Installation

You can install the package via composer:

composer require digitonic/dealmaker-api

You can publish the config file with:

php artisan vendor:publish --tag="dealmaker-api-config"

This is the contents of the published config file:

return [
    /**
     * The Client ID displayed when you created the OAuth application in the portal
     * This is typically called the "Public Key" in the portal
     */
    'client_id' => env('DEALMAKER_CLIENT_ID', ''),

    /**
     * The Client Secret displayed when you created the OAuth application in the portal
     * This is typically called the "Secret Key" in the portal
     */
    'client_secret' => env('DEALMAKER_CLIENT_SECRET', ''),

    /**
     * The scope is established when you created the OAuth application
     * This is typically called the "Scopes" in the portal
     */
    'scopes' => env('DEALMAKER_SCOPES', ''),
    
        /**
     * The DealMaker Deal ID for the current investment landing page
     */
    'deal_id' => env('DEALMAKER_DEAL_ID', ''),
];

Usage

$dealmakerApi = new Digitonic\DealmakerApi\DealmakerApi();
$deals = new Digitonic\DealmakerApi\Requests\Deal\ListDeals();

$response = $dealmakerApi->send($deals);

Testing

composer test

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.

digitonic / dealmaker-api

Maintainers

Details