clicksend / clicksend-php
Installs: 1 007 198
Dependents: 11
Suggesters: 0
Security: 0
Stars: 27
Watchers: 21
Forks: 14
Open Issues: 7
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2|^7.3
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
- dev-master
- v5.0.79
- 5.0.78.x-dev
- 5.0.77.x-dev
- 5.0.76.x-dev
- v5.0.75
- v5.0.74
- v5.0.73
- v5.0.72
- v5.0.70
- v5.0.69
- v5.0.68
- v5.0.67
- v5.0.66
- v5.0.65
- v5.0.64
- v5.0.63
- v5.0.61
- v5.0.60
- v5.0.57
- v5.0.52
- v5.0.51
- v5.0.50
- v5.0.49
- v5.0.48
- v5.0.46
- v5.0.45
- v5.0.38
- v5.0.37
- v5.0.36
- v5.0.35
- v5.0.34
- v5.0.33
- v5.0.32
- v5.0.31
- v5.0.30
- v5.0.29
- v5.0.28
- v5.0.27
- v5.0.26
- v5.0.23
- v5.0.22
- v5.0.20
- v5.0.19
- v5.0.18
- v5.0.17
- v5.0.16
- v5.0.15
- v5.0.12
- v5.0.11
- v5.0.9
- v5.0.8
- v5.0.7
- v5.0.6
- v5.0.5
- v5.0.1
- v4.0.4
- v4.0.3
- v4.0.2
- v4.0.1
- v3.1.3
- v3.1.2
- v3.1.1
- v3.1
- v3.0
- dev-develop
- dev-src-update
This package is not auto-updated.
Last update: 2024-11-21 12:16:14 UTC
README
This is an official SDK for ClickSend Below you will find a current list of the available methods for clicksend. NOTE: You will need to create a free account to use the API. You can register here..
This PHP package is automatically generated by the ClickSend Codegen project:
- API version: 3.1
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/git_user_id/git_repo_id.git"
}
],
"require": {
"git_user_id/git_repo_id": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/ClickSendClient-php/vendor/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); try { $result = $apiInstance->accountGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountGet: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \ClickSend\Model\Account(); // \ClickSend\Model\Account | Account model try { $result = $apiInstance->accountPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountPost: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $year = 56; // int | Year to filter by (yyyy) $month = 56; // int | Month to filter by (mm) try { $result = $apiInstance->accountUseageBySubaccountGet($year, $month); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountUseageBySubaccountGet: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \ClickSend\Model\AccountVerify(); // \ClickSend\Model\AccountVerify | Account details try { $result = $apiInstance->accountVerifySendPut($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountVerifySendPut: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $activation_token = 56; // int | try { $result = $apiInstance->accountVerifyVerifyByActivationTokenPut($activation_token); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->accountVerifyVerifyByActivationTokenPut: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \ClickSend\Model\ForgotPassword(); // \ClickSend\Model\ForgotPassword | try { $result = $apiInstance->forgotPasswordPut($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->forgotPasswordPut: ', $e->getMessage(), PHP_EOL; } // Configure HTTP basic authorization: BasicAuth $config = ClickSend\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \ClickSend\Model\AccountForgotPasswordVerify(); // \ClickSend\Model\AccountForgotPasswordVerify | verifyPassword data try { $result = $apiInstance->forgotPasswordVerifyPut($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->forgotPasswordVerifyPut: ', $e->getMessage(), PHP_EOL; } $apiInstance = new ClickSend\Api\AccountApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); $body = new \ClickSend\Model\ForgotUsername(); // \ClickSend\Model\ForgotUsername | try { $result = $apiInstance->forgotUsernamePut($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->forgotUsernamePut: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://rest.clicksend.com/v3
Documentation For Models
- Account
- AccountForgotPasswordVerify
- AccountVerify
- Address
- Attachment
- Contact
- ContactList
- ContactListImport
- CountryListIds
- CreditCard
- DateBefore
- DeliveryIssue
- DeliveryReceiptRule
- EmailAddress
- EmailCampaign
- EmailFrom
- EmailRecipient
- EmailSMSAddress
- EmailTemplateNew
- EmailTemplateUpdate
- FaxMessage
- FaxMessageCollection
- Fields
- FieldsFields
- ForgotPassword
- ForgotUsername
- InboundFaxRule
- InboundSMSRule
- MmsCampaign
- MmsMessage
- MmsMessageCollection
- PostLetter
- PostPostcard
- PostRecipient
- ResellerAccount
- ResellerAccountTransferCredit
- SmsCampaign
- SmsMessage
- SmsMessageCollection
- SmsTemplate
- StrippedString
- Subaccount
- UploadFile
- Url
- VoiceMessage
- VoiceMessageCollection
Documentation For Authorization
BasicAuth
- Type: HTTP basic authentication