macklus/yii2-freshdesk

Simple Yii2 module to extend Freshdesk API

1.0.0 2017-12-14 06:39 UTC

Requires

• mpclarkson/freshdesk-php-sdk: dev-master
• yiisoft/yii2: ~2.0.0

GPL-3.0+

• José Pedro Andrés

• api
• extension
• yii2
• Freshdesk

README

Simple Yii2 module to extend Freshdesk API

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist macklus/yii2-freshdesk "*"

or add

"macklus/yii2-freshdesk": "*"

to the require section of your composer.json file.

Usage

Once the extension is installed, simply declare a component in your config file:

'freshdesk' => [
    'class' => 'macklus\freshdesk\Freshdesk',
    'api_key' => 'ThisIsAFakeApiKey',
    'domain' => 'macklus',
],

After that, you can call Freshdesk API by using:

$response = Yii::$app->freshdesk->tickets->create([
    'name' => 'Customer name',
    'email' => 'Customer Email',
    'cc_emails' => ['Customer Email'],
    'subject' => "Your ticket",
    'description' => 'The content of ticket',
    'status' => 2,
    'priority' => 1,
]);