/oauth2-talkdesk

Primary LanguagePHPMIT LicenseMIT

Talkdesk Provider for OAuth 2.0 Client

Latest Version Software License Total Downloads

This package provides Talkdesk OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require zingtree/oauth2-talkdesk

Usage

Usage is the same as The League's OAuth client, using \Zingtree\OAuth2\Client\Provider\Talkdesk as the provider.

Authorization Code Flow

$provider = new Zingtree\OAuth2\Client\Provider\Talkdesk([
    'clientId'          => '{talkdesk-client-id}',
    'clientSecret'      => '{talkdesk-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'subdomain'         => 'your-talkdesk-subdomain',
]);

For further usage of this package please refer to the core package documentation on "Authorization Code Grant".

Update and read subdomain after configuration

$currentSubdomain = $provider->getSubdomain();
$newSubdomain = $currentSubdomain . '-v2';
$provider->setSubdomain($newSubdomain);

The provider will not complete configuration if a subdomain is not provided and updating the subdomain will silently fail if the value provided does not return truthy from empty().

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.