maglr/freshsales-api-laravel

Wrapper on the REST Freshsales API for Laravel

dev-master 2022-04-25 22:00 UTC

Requires

• php: ^7 || ^8
• guzzlehttp/guzzle: ^7

MIT

• Evgeni Nurkov

• php
• rest
• api
• laravel
• freshsales

README

Wrapper on the REST Freshsales API for Laravel

Installation

Installation using composer:

composer require maglr/freshsales-api-laravel

Configuration

Change your default settings in app/config/freshsales.php:

return [
    'domain' => env('FRESHSALES_DOMAIN'),
    'api_key' => env('FRESHSALES_APIKEY'),
    'enable_rate_limit' => env('FRESHSALES_ENABLE_RATE_LIMIT'),
];

Usage

• Leads

Freshsales::leads()->create();
Freshsales::leads()->get();
Freshsales::leads()->convert();
Freshsales::leads()->list();
Freshsales::leads()->update();
Freshsales::leads()->assignOwner();
Freshsales::leads()->clone();
Freshsales::leads()->delete();
Freshsales::leads()->forget();
Freshsales::leads()->bulkDelete();
Freshsales::leads()->fields();
Freshsales::leads()->activities();
Freshsales::leads()->filters();
Freshsales::leads()->filter();
Freshsales::leads()->lookup();

• Contacts

Freshsales::contacts()->create();
Freshsales::contacts()->get();
Freshsales::contacts()->list();
Freshsales::contacts()->update();
Freshsales::contacts()->assignOwner();
Freshsales::contacts()->clone();
Freshsales::contacts()->delete();
Freshsales::contacts()->forget();
Freshsales::contacts()->bulkDelete();
Freshsales::contacts()->fields();
Freshsales::contacts()->activities();
Freshsales::contacts()->filters();
Freshsales::contacts()->filter();
Freshsales::contacts()->lookup();

• Accounts

Freshsales::accounts()->create();
Freshsales::accounts()->get();
Freshsales::accounts()->list();
Freshsales::accounts()->update();
Freshsales::accounts()->clone();
Freshsales::accounts()->delete();
Freshsales::accounts()->forget();
Freshsales::accounts()->bulkDelete();
Freshsales::accounts()->fields();
Freshsales::accounts()->filters();
Freshsales::accounts()->filter();
Freshsales::accounts()->lookup();

• Deals

Freshsales::deals()->create();
Freshsales::deals()->get();
Freshsales::deals()->list();
Freshsales::deals()->update();
Freshsales::deals()->clone();
Freshsales::deals()->delete();
Freshsales::deals()->forget();
Freshsales::deals()->bulkDelete();
Freshsales::deals()->fields();
Freshsales::deals()->filters();
Freshsales::deals()->filter();
Freshsales::deals()->lookup();

• Search

Freshsales::search()->query();
Freshsales::search()->lookup();

• Configuration

Freshsales::config()->owners();
Freshsales::config()->territories();
Freshsales::config()->deal_stages();
Freshsales::config()->currencies();
Freshsales::config()->deal_reasons();
Freshsales::config()->deal_types();
Freshsales::config()->lead_sources();
Freshsales::config()->industry_types();
Freshsales::config()->business_types();
Freshsales::config()->campaigns();
Freshsales::config()->deal_payment_statuses();
Freshsales::config()->deal_products();
Freshsales::config()->deal_pipelines();
Freshsales::config()->contact_statuses();
Freshsales::config()->sales_activity_types();
Freshsales::config()->sales_activity_outcomes();
Freshsales::config()->sales_activity_entity_types();
Freshsales::config()->get($api);

• Client - Inspired from ianfortier/Basic-Freshsales-API

Freshsales::client()->request();
Freshsales::client()->isRateLimitEnabled();
Freshsales::client()->enableRateLimit();
Freshsales::client()->disableRateLimit();
Freshsales::client()->getApiCallLimits();

Documentation

Freshsales API Docs