├── .php_cs ├── .travis.yml ├── README.md ├── composer.json ├── docs ├── Api │ ├── AccountApi.md │ ├── AccountRechargeApi.md │ ├── ContactApi.md │ ├── ContactListApi.md │ ├── CountriesApi.md │ ├── DeliveryIssuesApi.md │ ├── DetectAddressApi.md │ ├── EmailDeliveryReceiptRulesApi.md │ ├── EmailMarketingApi.md │ ├── EmailToSmsApi.md │ ├── FAXApi.md │ ├── FAXDeliveryReceiptRulesApi.md │ ├── GlobalSendingApi.md │ ├── InboundFAXRulesApi.md │ ├── InboundSMSRulesApi.md │ ├── MMSApi.md │ ├── MasterEmailTemplatesApi.md │ ├── MmsCampaignApi.md │ ├── NumberApi.md │ ├── PostLetterApi.md │ ├── PostPostcardApi.md │ ├── PostReturnAddressApi.md │ ├── ReferralAccountApi.md │ ├── ResellerAccountApi.md │ ├── SMSApi.md │ ├── SMSDeliveryReceiptRulesApi.md │ ├── SearchApi.md │ ├── SmsCampaignApi.md │ ├── StatisticsApi.md │ ├── SubaccountApi.md │ ├── TimezonesApi.md │ ├── TransactionalEmailApi.md │ ├── TransferCreditApi.md │ ├── UploadApi.md │ ├── UserEmailTemplatesApi.md │ ├── VoiceApi.md │ └── VoiceDeliveryReceiptRulesApi.md └── Model │ ├── Account.md │ ├── AccountForgotPasswordVerify.md │ ├── AccountVerify.md │ ├── Address.md │ ├── Attachment.md │ ├── Contact.md │ ├── ContactList.md │ ├── ContactListImport.md │ ├── CountryListIds.md │ ├── CreditCard.md │ ├── DateBefore.md │ ├── DeliveryIssue.md │ ├── DeliveryReceiptRule.md │ ├── Email.md │ ├── EmailAddress.md │ ├── EmailCampaign.md │ ├── EmailFrom.md │ ├── EmailRecipient.md │ ├── EmailSMSAddress.md │ ├── EmailTemplateNew.md │ ├── EmailTemplateUpdate.md │ ├── FaxMessage.md │ ├── FaxMessageCollection.md │ ├── Fields.md │ ├── FieldsFields.md │ ├── ForgotPassword.md │ ├── ForgotUsername.md │ ├── InboundFaxRule.md │ ├── InboundSMSRule.md │ ├── MmsCampaign.md │ ├── MmsMessage.md │ ├── MmsMessageCollection.md │ ├── PostLetter.md │ ├── PostPostcard.md │ ├── PostRecipient.md │ ├── ResellerAccount.md │ ├── ResellerAccountTransferCredit.md │ ├── SmsCampaign.md │ ├── SmsMessage.md │ ├── SmsMessageCollection.md │ ├── SmsTemplate.md │ ├── StrippedString.md │ ├── Subaccount.md │ ├── UploadFile.md │ ├── Url.md │ ├── VoiceMessage.md │ └── VoiceMessageCollection.md ├── lib ├── Api │ ├── AccountApi.php │ ├── AccountRechargeApi.php │ ├── ContactApi.php │ ├── ContactListApi.php │ ├── CountriesApi.php │ ├── DeliveryIssuesApi.php │ ├── DetectAddressApi.php │ ├── EmailDeliveryReceiptRulesApi.php │ ├── EmailMarketingApi.php │ ├── EmailToSmsApi.php │ ├── FAXApi.php │ ├── FAXDeliveryReceiptRulesApi.php │ ├── GlobalSendingApi.php │ ├── InboundFAXRulesApi.php │ ├── InboundSMSRulesApi.php │ ├── MMSApi.php │ ├── MasterEmailTemplatesApi.php │ ├── MmsCampaignApi.php │ ├── NumberApi.php │ ├── PostLetterApi.php │ ├── PostPostcardApi.php │ ├── PostReturnAddressApi.php │ ├── ReferralAccountApi.php │ ├── ResellerAccountApi.php │ ├── SMSApi.php │ ├── SMSDeliveryReceiptRulesApi.php │ ├── SearchApi.php │ ├── SmsCampaignApi.php │ ├── StatisticsApi.php │ ├── SubaccountApi.php │ ├── TimezonesApi.php │ ├── TransactionalEmailApi.php │ ├── TransferCreditApi.php │ ├── UploadApi.php │ ├── UserEmailTemplatesApi.php │ ├── VoiceApi.php │ └── VoiceDeliveryReceiptRulesApi.php ├── ApiException.php ├── Configuration.php ├── HeaderSelector.php ├── Model │ ├── Account.php │ ├── AccountForgotPasswordVerify.php │ ├── AccountVerify.php │ ├── Address.php │ ├── Attachment.php │ ├── Contact.php │ ├── ContactList.php │ ├── ContactListImport.php │ ├── CountryListIds.php │ ├── CreditCard.php │ ├── DateBefore.php │ ├── DeliveryIssue.php │ ├── DeliveryReceiptRule.php │ ├── Email.php │ ├── EmailAddress.php │ ├── EmailCampaign.php │ ├── EmailFrom.php │ ├── EmailRecipient.php │ ├── EmailSMSAddress.php │ ├── EmailTemplateNew.php │ ├── EmailTemplateUpdate.php │ ├── FaxMessage.php │ ├── FaxMessageCollection.php │ ├── Fields.php │ ├── FieldsFields.php │ ├── ForgotPassword.php │ ├── ForgotUsername.php │ ├── InboundFaxRule.php │ ├── InboundSMSRule.php │ ├── MmsCampaign.php │ ├── MmsMessage.php │ ├── MmsMessageCollection.php │ ├── ModelInterface.php │ ├── PostLetter.php │ ├── PostPostcard.php │ ├── PostRecipient.php │ ├── ResellerAccount.php │ ├── ResellerAccountTransferCredit.php │ ├── SmsCampaign.php │ ├── SmsMessage.php │ ├── SmsMessageCollection.php │ ├── SmsTemplate.php │ ├── StrippedString.php │ ├── Subaccount.php │ ├── UploadFile.php │ ├── Url.php │ ├── VoiceMessage.php │ └── VoiceMessageCollection.php └── ObjectSerializer.php ├── phpunit.xml.dist └── test ├── Api ├── AccountApiTest.php ├── AccountRechargeApiTest.php ├── ContactApiTest.php ├── ContactListApiTest.php ├── CountriesApiTest.php ├── DeliveryIssuesApiTest.php ├── DetectAddressApiTest.php ├── EmailDeliveryReceiptRulesApiTest.php ├── EmailMarketingApiTest.php ├── EmailToSmsApiTest.php ├── FAXApiTest.php ├── FAXDeliveryReceiptRulesApiTest.php ├── GlobalSendingApiTest.php ├── InboundFAXRulesApiTest.php ├── InboundSMSRulesApiTest.php ├── MMSApiTest.php ├── MasterEmailTemplatesApiTest.php ├── MmsCampaignApiTest.php ├── NumberApiTest.php ├── PostLetterApiTest.php ├── PostPostcardApiTest.php ├── PostReturnAddressApiTest.php ├── ReferralAccountApiTest.php ├── ResellerAccountApiTest.php ├── SMSApiTest.php ├── SMSDeliveryReceiptRulesApiTest.php ├── SearchApiTest.php ├── SmsCampaignApiTest.php ├── StatisticsApiTest.php ├── SubaccountApiTest.php ├── TimezonesApiTest.php ├── TransactionalEmailApiTest.php ├── TransferCreditApiTest.php ├── UploadApiTest.php ├── UserEmailTemplatesApiTest.php ├── VoiceApiTest.php └── VoiceDeliveryReceiptRulesApiTest.php └── Model ├── AccountForgotPasswordVerifyTest.php ├── AccountTest.php ├── AccountVerifyTest.php ├── AddressTest.php ├── AttachmentTest.php ├── ContactListImportTest.php ├── ContactListTest.php ├── ContactTest.php ├── CountryListIdsTest.php ├── CreditCardTest.php ├── DateBeforeTest.php ├── DeliveryIssueTest.php ├── DeliveryReceiptRuleTest.php ├── EmailAddressTest.php ├── EmailCampaignTest.php ├── EmailFromTest.php ├── EmailRecipientTest.php ├── EmailSMSAddressTest.php ├── EmailTemplateNewTest.php ├── EmailTemplateUpdateTest.php ├── EmailTest.php ├── FaxMessageCollectionTest.php ├── FaxMessageTest.php ├── FieldsFieldsTest.php ├── FieldsTest.php ├── ForgotPasswordTest.php ├── ForgotUsernameTest.php ├── InboundFaxRuleTest.php ├── InboundSMSRuleTest.php ├── MmsCampaignTest.php ├── MmsMessageCollectionTest.php ├── MmsMessageTest.php ├── PostLetterTest.php ├── PostPostcardTest.php ├── PostRecipientTest.php ├── ResellerAccountTest.php ├── ResellerAccountTransferCreditTest.php ├── SmsCampaignTest.php ├── SmsMessageCollectionTest.php ├── SmsMessageTest.php ├── SmsTemplateTest.php ├── StrippedStringTest.php ├── SubaccountTest.php ├── UploadFileTest.php ├── UrlTest.php ├── VoiceMessageCollectionTest.php └── VoiceMessageTest.php /.php_cs: -------------------------------------------------------------------------------- 1 | setUsingCache(true) 5 | ->setRules([ 6 | '@PSR2' => true, 7 | 'ordered_imports' => true, 8 | 'phpdoc_order' => true, 9 | 'array_syntax' => [ 'syntax' => 'short' ], 10 | 'strict_comparison' => true, 11 | 'strict_param' => true, 12 | 'no_trailing_whitespace' => false, 13 | 'no_trailing_whitespace_in_comment' => false, 14 | 'braces' => false, 15 | 'single_blank_line_at_eof' => false, 16 | 'blank_line_after_namespace' => false, 17 | ]) 18 | ->setFinder( 19 | PhpCsFixer\Finder::create() 20 | ->exclude('test') 21 | ->exclude('tests') 22 | ->in(__DIR__) 23 | ); 24 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: php 2 | sudo: false 3 | php: 4 | - 5.4 5 | - 5.5 6 | - 5.6 7 | - 7.0 8 | - hhvm 9 | before_install: "composer install" 10 | script: "vendor/bin/phpunit" 11 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "clicksend/clicksend-php", 3 | "description": "", 4 | "keywords": [ 5 | "swagger", 6 | "php", 7 | "sdk", 8 | "api" 9 | ], 10 | "homepage": "http://swagger.io", 11 | "license": "proprietary", 12 | "authors": [ 13 | { 14 | "name": "Swagger and contributors", 15 | "homepage": "https://github.com/swagger-api/swagger-codegen" 16 | } 17 | ], 18 | "require": { 19 | "php": ">=5.5", 20 | "ext-curl": "*", 21 | "ext-json": "*", 22 | "ext-mbstring": "*", 23 | "guzzlehttp/guzzle": "^6.2|^7.3" 24 | }, 25 | "require-dev": { 26 | "phpunit/phpunit": "^4.8", 27 | "squizlabs/php_codesniffer": "~2.6", 28 | "friendsofphp/php-cs-fixer": "~2.12" 29 | }, 30 | "autoload": { 31 | "psr-4": { "ClickSend\\" : "lib/" } 32 | }, 33 | "autoload-dev": { 34 | "psr-4": { "ClickSend\\" : "test/" } 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /docs/Api/CountriesApi.md: -------------------------------------------------------------------------------- 1 | # ClickSend\CountriesApi 2 | 3 | All URIs are relative to *https://rest.clicksend.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**countriesGet**](CountriesApi.md#countriesget) | **GET** /countries | Get all country codes 8 | 9 | # **countriesGet** 10 | > string countriesGet() 11 | 12 | Get all country codes 13 | 14 | Get all countries 15 | 16 | ### Example 17 | ```php 18 | countriesGet(); 29 | print_r($result); 30 | } catch (Exception $e) { 31 | echo 'Exception when calling CountriesApi->countriesGet: ', $e->getMessage(), PHP_EOL; 32 | } 33 | ?> 34 | ``` 35 | 36 | ### Parameters 37 | This endpoint does not need any parameter. 38 | 39 | ### Return type 40 | 41 | **string** 42 | 43 | ### Authorization 44 | 45 | No authorization required 46 | 47 | ### HTTP request headers 48 | 49 | - **Content-Type**: Not defined 50 | - **Accept**: application/json 51 | 52 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 53 | 54 | -------------------------------------------------------------------------------- /docs/Api/DetectAddressApi.md: -------------------------------------------------------------------------------- 1 | # ClickSend\DetectAddressApi 2 | 3 | All URIs are relative to *https://rest.clicksend.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**detectAddressPost**](DetectAddressApi.md#detectaddresspost) | **POST** /post/letters/detect-address | Detects address in uploaded file. 8 | 9 | # **detectAddressPost** 10 | > string detectAddressPost($body) 11 | 12 | Detects address in uploaded file. 13 | 14 | Detects address in uploaded file. 15 | 16 | ### Example 17 | ```php 18 | setUsername('YOUR_USERNAME') 23 | ->setPassword('YOUR_PASSWORD'); 24 | 25 | 26 | $apiInstance = new ClickSend\Api\DetectAddressApi( 27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 28 | // This is optional, `GuzzleHttp\Client` will be used as default. 29 | new GuzzleHttp\Client(), 30 | $config 31 | ); 32 | $body = new \ClickSend\Model\UploadFile(); // \ClickSend\Model\UploadFile | Your file to be uploaded 33 | 34 | try { 35 | $result = $apiInstance->detectAddressPost($body); 36 | print_r($result); 37 | } catch (Exception $e) { 38 | echo 'Exception when calling DetectAddressApi->detectAddressPost: ', $e->getMessage(), PHP_EOL; 39 | } 40 | ?> 41 | ``` 42 | 43 | ### Parameters 44 | 45 | Name | Type | Description | Notes 46 | ------------- | ------------- | ------------- | ------------- 47 | **body** | [**\ClickSend\Model\UploadFile**](../Model/UploadFile.md)| Your file to be uploaded | 48 | 49 | ### Return type 50 | 51 | **string** 52 | 53 | ### Authorization 54 | 55 | [BasicAuth](../../README.md#BasicAuth) 56 | 57 | ### HTTP request headers 58 | 59 | - **Content-Type**: application/json 60 | - **Accept**: application/json 61 | 62 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 63 | 64 | -------------------------------------------------------------------------------- /docs/Api/ReferralAccountApi.md: -------------------------------------------------------------------------------- 1 | # ClickSend\ReferralAccountApi 2 | 3 | All URIs are relative to *https://rest.clicksend.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**referralAccountsGet**](ReferralAccountApi.md#referralaccountsget) | **GET** /referral/accounts | Get all referral accounts 8 | 9 | # **referralAccountsGet** 10 | > string referralAccountsGet($page, $limit) 11 | 12 | Get all referral accounts 13 | 14 | Get all referral accounts 15 | 16 | ### Example 17 | ```php 18 | setUsername('YOUR_USERNAME') 23 | ->setPassword('YOUR_PASSWORD'); 24 | 25 | 26 | $apiInstance = new ClickSend\Api\ReferralAccountApi( 27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 28 | // This is optional, `GuzzleHttp\Client` will be used as default. 29 | new GuzzleHttp\Client(), 30 | $config 31 | ); 32 | $page = 1; // int | Page number 33 | $limit = 10; // int | Number of records per page 34 | 35 | try { 36 | $result = $apiInstance->referralAccountsGet($page, $limit); 37 | print_r($result); 38 | } catch (Exception $e) { 39 | echo 'Exception when calling ReferralAccountApi->referralAccountsGet: ', $e->getMessage(), PHP_EOL; 40 | } 41 | ?> 42 | ``` 43 | 44 | ### Parameters 45 | 46 | Name | Type | Description | Notes 47 | ------------- | ------------- | ------------- | ------------- 48 | **page** | **int**| Page number | [optional] [default to 1] 49 | **limit** | **int**| Number of records per page | [optional] [default to 10] 50 | 51 | ### Return type 52 | 53 | **string** 54 | 55 | ### Authorization 56 | 57 | [BasicAuth](../../README.md#BasicAuth) 58 | 59 | ### HTTP request headers 60 | 61 | - **Content-Type**: Not defined 62 | - **Accept**: application/json 63 | 64 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 65 | 66 | -------------------------------------------------------------------------------- /docs/Api/SearchApi.md: -------------------------------------------------------------------------------- 1 | # ClickSend\SearchApi 2 | 3 | All URIs are relative to *https://rest.clicksend.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**searchContactsListsGet**](SearchApi.md#searchcontactslistsget) | **GET** /search/contacts-lists | Get list of searched contact list 8 | 9 | # **searchContactsListsGet** 10 | > string searchContactsListsGet($q, $page, $limit) 11 | 12 | Get list of searched contact list 13 | 14 | Get list of searched contact list 15 | 16 | ### Example 17 | ```php 18 | setUsername('YOUR_USERNAME') 23 | ->setPassword('YOUR_PASSWORD'); 24 | 25 | 26 | $apiInstance = new ClickSend\Api\SearchApi( 27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 28 | // This is optional, `GuzzleHttp\Client` will be used as default. 29 | new GuzzleHttp\Client(), 30 | $config 31 | ); 32 | $q = "q_example"; // string | Your keyword or query. 33 | $page = 1; // int | Page number 34 | $limit = 10; // int | Number of records per page 35 | 36 | try { 37 | $result = $apiInstance->searchContactsListsGet($q, $page, $limit); 38 | print_r($result); 39 | } catch (Exception $e) { 40 | echo 'Exception when calling SearchApi->searchContactsListsGet: ', $e->getMessage(), PHP_EOL; 41 | } 42 | ?> 43 | ``` 44 | 45 | ### Parameters 46 | 47 | Name | Type | Description | Notes 48 | ------------- | ------------- | ------------- | ------------- 49 | **q** | **string**| Your keyword or query. | 50 | **page** | **int**| Page number | [optional] [default to 1] 51 | **limit** | **int**| Number of records per page | [optional] [default to 10] 52 | 53 | ### Return type 54 | 55 | **string** 56 | 57 | ### Authorization 58 | 59 | [BasicAuth](../../README.md#BasicAuth) 60 | 61 | ### HTTP request headers 62 | 63 | - **Content-Type**: Not defined 64 | - **Accept**: application/json 65 | 66 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 67 | 68 | -------------------------------------------------------------------------------- /docs/Api/TimezonesApi.md: -------------------------------------------------------------------------------- 1 | # ClickSend\TimezonesApi 2 | 3 | All URIs are relative to *https://rest.clicksend.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**timezonesGet**](TimezonesApi.md#timezonesget) | **GET** /timezones | Get supported list of timezones. 8 | 9 | # **timezonesGet** 10 | > string timezonesGet($page, $limit) 11 | 12 | Get supported list of timezones. 13 | 14 | Get supported list of timezones. 15 | 16 | ### Example 17 | ```php 18 | setUsername('YOUR_USERNAME') 23 | ->setPassword('YOUR_PASSWORD'); 24 | 25 | 26 | $apiInstance = new ClickSend\Api\TimezonesApi( 27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 28 | // This is optional, `GuzzleHttp\Client` will be used as default. 29 | new GuzzleHttp\Client(), 30 | $config 31 | ); 32 | $page = 1; // int | Page number 33 | $limit = 10; // int | Number of records per page 34 | 35 | try { 36 | $result = $apiInstance->timezonesGet($page, $limit); 37 | print_r($result); 38 | } catch (Exception $e) { 39 | echo 'Exception when calling TimezonesApi->timezonesGet: ', $e->getMessage(), PHP_EOL; 40 | } 41 | ?> 42 | ``` 43 | 44 | ### Parameters 45 | 46 | Name | Type | Description | Notes 47 | ------------- | ------------- | ------------- | ------------- 48 | **page** | **int**| Page number | [optional] [default to 1] 49 | **limit** | **int**| Number of records per page | [optional] [default to 10] 50 | 51 | ### Return type 52 | 53 | **string** 54 | 55 | ### Authorization 56 | 57 | [BasicAuth](../../README.md#BasicAuth) 58 | 59 | ### HTTP request headers 60 | 61 | - **Content-Type**: Not defined 62 | - **Accept**: application/json 63 | 64 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 65 | 66 | -------------------------------------------------------------------------------- /docs/Api/TransferCreditApi.md: -------------------------------------------------------------------------------- 1 | # ClickSend\TransferCreditApi 2 | 3 | All URIs are relative to *https://rest.clicksend.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**resellerTransferCreditPut**](TransferCreditApi.md#resellertransfercreditput) | **PUT** /reseller/transfer-credit | Transfer Credit 8 | 9 | # **resellerTransferCreditPut** 10 | > string resellerTransferCreditPut($body) 11 | 12 | Transfer Credit 13 | 14 | Transfer Credit 15 | 16 | ### Example 17 | ```php 18 | setUsername('YOUR_USERNAME') 23 | ->setPassword('YOUR_PASSWORD'); 24 | 25 | 26 | $apiInstance = new ClickSend\Api\TransferCreditApi( 27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 28 | // This is optional, `GuzzleHttp\Client` will be used as default. 29 | new GuzzleHttp\Client(), 30 | $config 31 | ); 32 | $body = new \ClickSend\Model\ResellerAccountTransferCredit(); // \ClickSend\Model\ResellerAccountTransferCredit | ResellerAccountTransferCredit model 33 | 34 | try { 35 | $result = $apiInstance->resellerTransferCreditPut($body); 36 | print_r($result); 37 | } catch (Exception $e) { 38 | echo 'Exception when calling TransferCreditApi->resellerTransferCreditPut: ', $e->getMessage(), PHP_EOL; 39 | } 40 | ?> 41 | ``` 42 | 43 | ### Parameters 44 | 45 | Name | Type | Description | Notes 46 | ------------- | ------------- | ------------- | ------------- 47 | **body** | [**\ClickSend\Model\ResellerAccountTransferCredit**](../Model/ResellerAccountTransferCredit.md)| ResellerAccountTransferCredit model | 48 | 49 | ### Return type 50 | 51 | **string** 52 | 53 | ### Authorization 54 | 55 | [BasicAuth](../../README.md#BasicAuth) 56 | 57 | ### HTTP request headers 58 | 59 | - **Content-Type**: application/json 60 | - **Accept**: application/json 61 | 62 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 63 | 64 | -------------------------------------------------------------------------------- /docs/Api/UploadApi.md: -------------------------------------------------------------------------------- 1 | # ClickSend\UploadApi 2 | 3 | All URIs are relative to *https://rest.clicksend.com/v3* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**uploadsPost**](UploadApi.md#uploadspost) | **POST** /uploads | Upload File 8 | 9 | # **uploadsPost** 10 | > string uploadsPost($body, $convert) 11 | 12 | Upload File 13 | 14 | Upload File 15 | 16 | ### Example 17 | ```php 18 | setUsername('YOUR_USERNAME') 23 | ->setPassword('YOUR_PASSWORD'); 24 | 25 | 26 | $apiInstance = new ClickSend\Api\UploadApi( 27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 28 | // This is optional, `GuzzleHttp\Client` will be used as default. 29 | new GuzzleHttp\Client(), 30 | $config 31 | ); 32 | $body = new \ClickSend\Model\UploadFile(); // \ClickSend\Model\UploadFile | Your file to be uploaded 33 | $convert = "convert_example"; // string | 34 | 35 | try { 36 | $result = $apiInstance->uploadsPost($body, $convert); 37 | print_r($result); 38 | } catch (Exception $e) { 39 | echo 'Exception when calling UploadApi->uploadsPost: ', $e->getMessage(), PHP_EOL; 40 | } 41 | ?> 42 | ``` 43 | 44 | ### Parameters 45 | 46 | Name | Type | Description | Notes 47 | ------------- | ------------- | ------------- | ------------- 48 | **body** | [**\ClickSend\Model\UploadFile**](../Model/UploadFile.md)| Your file to be uploaded | 49 | **convert** | **string**| | 50 | 51 | ### Return type 52 | 53 | **string** 54 | 55 | ### Authorization 56 | 57 | [BasicAuth](../../README.md#BasicAuth) 58 | 59 | ### HTTP request headers 60 | 61 | - **Content-Type**: application/json 62 | - **Accept**: application/json 63 | 64 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 65 | 66 | -------------------------------------------------------------------------------- /docs/Model/Account.md: -------------------------------------------------------------------------------- 1 | # Account 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **username** | **string** | Your username | 7 | **password** | **string** | Your password | 8 | **user_phone** | **string** | Your phone number in E.164 format. | 9 | **user_email** | **string** | Your email | 10 | **user_first_name** | **string** | Your first name | 11 | **user_last_name** | **string** | Your last name | 12 | **account_name** | **string** | Your delivery to value. | 13 | **country** | **string** | Your country | 14 | 15 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 16 | 17 | -------------------------------------------------------------------------------- /docs/Model/AccountForgotPasswordVerify.md: -------------------------------------------------------------------------------- 1 | # AccountForgotPasswordVerify 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **subaccount_id** | **int** | ID of subaccount | 7 | **activation_token** | **string** | Activation token | 8 | **password** | **string** | Password | 9 | 10 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/AccountVerify.md: -------------------------------------------------------------------------------- 1 | # AccountVerify 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **country** | **string** | Country code | 7 | **user_phone** | **string** | User's phone number | 8 | **type** | **string** | Type of verification | 9 | 10 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/Address.md: -------------------------------------------------------------------------------- 1 | # Address 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **address_name** | **string** | Your address name. | 7 | **address_line_1** | **string** | Your address line 1 | 8 | **address_city** | **string** | Your city | 9 | **address_postal_code** | **string** | Your postal code | 10 | **address_country** | **string** | Your country | 11 | **address_line_2** | **string** | Your address line 2 | [optional] 12 | **address_state** | **string** | Your state | [optional] 13 | 14 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 15 | 16 | -------------------------------------------------------------------------------- /docs/Model/Attachment.md: -------------------------------------------------------------------------------- 1 | # Attachment 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content** | **string** | The base64-encoded contents of the file. | 7 | **type** | **string** | The type of file being attached. | 8 | **filename** | **string** | The name of the file being attached. | 9 | **disposition** | **string** | Inline for content that can be displayed within the email, or attachment for any other files. | 10 | **content_id** | **string** | An ID for the content. | 11 | 12 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/Contact.md: -------------------------------------------------------------------------------- 1 | # Contact 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **phone_number** | **string** | Your phone number in E.164 format. Must be provided if no fax number or email. | 7 | **custom_1** | **string** | | 8 | **email** | **string** | Your email. Must be provided if no phone number or fax number. | [optional] 9 | **fax_number** | **string** | Your fax number. Must be provided if no phone number or email. | [optional] 10 | **first_name** | **string** | Your first name. | [optional] 11 | **address_line_1** | **string** | Your street address | [optional] 12 | **address_line_2** | **string** | | [optional] 13 | **address_city** | **string** | Your nearest city | [optional] 14 | **address_state** | **string** | Your current state | [optional] 15 | **address_postal_code** | **string** | Your current postcode | [optional] 16 | **address_country** | **string** | Your current country | [optional] 17 | **organization_name** | **string** | Your organisation name | [optional] 18 | **custom_2** | **string** | | [optional] 19 | **custom_3** | **string** | | [optional] 20 | **custom_4** | **string** | | [optional] 21 | **last_name** | **string** | Your last name | [optional] 22 | 23 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 24 | 25 | -------------------------------------------------------------------------------- /docs/Model/ContactList.md: -------------------------------------------------------------------------------- 1 | # ContactList 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **list_name** | **string** | Your list name. | 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/ContactListImport.md: -------------------------------------------------------------------------------- 1 | # ContactListImport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **file_url** | **string** | URL of file to process | 7 | **field_order** | **string[]** | Order of fields in file | 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/CountryListIds.md: -------------------------------------------------------------------------------- 1 | # CountryListIds 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **country_list_ids** | **int[]** | Array of country ids | 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/CreditCard.md: -------------------------------------------------------------------------------- 1 | # CreditCard 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **number** | **string** | Credit card number | 7 | **expiry_month** | **int** | Expiry month of credit card | 8 | **expiry_year** | **int** | Expiry year of credit card | 9 | **cvc** | **int** | CVC number of credit card | 10 | **name** | **string** | Name printed on credit card | 11 | **bank_name** | **string** | Name of bank that credit card belongs to | 12 | 13 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 14 | 15 | -------------------------------------------------------------------------------- /docs/Model/DateBefore.md: -------------------------------------------------------------------------------- 1 | # DateBefore 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **date_before** | **float** | An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read. | [optional] 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/DeliveryIssue.md: -------------------------------------------------------------------------------- 1 | # DeliveryIssue 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **message_id** | **string** | The message id of the message. | [optional] 7 | **type** | **string** | The type of message, must be one of the following values SMS, MMS, VOICE, EMAIL_MARKETING, EMAIL_TRANSACTIONAL, FAX, POST. | 8 | **description** | **string** | The description of the message. | 9 | **client_comments** | **string** | The user's comments. | [optional] 10 | **email_address** | **string** | The user's email address. | 11 | 12 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/DeliveryReceiptRule.md: -------------------------------------------------------------------------------- 1 | # DeliveryReceiptRule 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **rule_name** | **string** | Rule Name. | 7 | **match_type** | **float** | Match Type. 0=All reports. | 8 | **action** | **string** | Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE). | 9 | **action_address** | **string** | Action address. | 10 | **enabled** | **float** | Enabled: Disabled=0 or Enabled=1. | 11 | 12 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/Email.md: -------------------------------------------------------------------------------- 1 | # Email 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **to** | [**\ClickSend\Model\EmailRecipient[]**](EmailRecipient.md) | Array of To Recipient items. | 7 | **cc** | [**\ClickSend\Model\EmailRecipient[]**](EmailRecipient.md) | Array of Cc Recipient items. | [optional] 8 | **bcc** | [**\ClickSend\Model\EmailRecipient[]**](EmailRecipient.md) | Array of Bcc Recipient items. | [optional] 9 | **from** | [**\ClickSend\Model\EmailFrom**](EmailFrom.md) | | 10 | **subject** | **string** | Subject of the email. | [optional] 11 | **body** | **string** | Body of the email. | 12 | **attachments** | [**\ClickSend\Model\Attachment[]**](Attachment.md) | Array of Attachment items. | [optional] 13 | **schedule** | **float** | Schedule. | [optional] 14 | 15 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 16 | 17 | -------------------------------------------------------------------------------- /docs/Model/EmailAddress.md: -------------------------------------------------------------------------------- 1 | # EmailAddress 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email_address** | **string** | Email to be allowed. | 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/EmailCampaign.md: -------------------------------------------------------------------------------- 1 | # EmailCampaign 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **string** | Your campaign name. | 7 | **subject** | **string** | Your campaign subject. | 8 | **body** | **string** | Your campaign message. | 9 | **from_email_address_id** | **float** | The allowed email address id. | 10 | **from_name** | **string** | Your name or business name. | 11 | **template_id** | **float** | Your template id. | [optional] 12 | **list_id** | **float** | Your contact list id. | 13 | **schedule** | **int** | Your schedule timestamp. | [optional] [default to 0] 14 | 15 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 16 | 17 | -------------------------------------------------------------------------------- /docs/Model/EmailFrom.md: -------------------------------------------------------------------------------- 1 | # EmailFrom 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email_address_id** | **string** | Email address id of the recipient. | 7 | **name** | **string** | Name of the recipient. | [optional] 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/EmailRecipient.md: -------------------------------------------------------------------------------- 1 | # EmailRecipient 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **string** | Email of the recipient. | 7 | **name** | **string** | Name of the recipient. | [optional] 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/EmailSMSAddress.md: -------------------------------------------------------------------------------- 1 | # EmailSMSAddress 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email_address** | **string** | Your email address | 7 | **from** | **string** | Your sender id | 8 | **subaccount_id** | **string** | Your subaccount id | [optional] 9 | 10 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/EmailTemplateNew.md: -------------------------------------------------------------------------------- 1 | # EmailTemplateNew 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **template_name** | **string** | The intended name for the new template. | 7 | **template_id_master** | **float** | The ID of the master template you want to base on. | 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/EmailTemplateUpdate.md: -------------------------------------------------------------------------------- 1 | # EmailTemplateUpdate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **template_name** | **string** | The intended name for the template. | [optional] 7 | **body** | **string** | Your template body. | 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/FaxMessage.md: -------------------------------------------------------------------------------- 1 | # FaxMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **source** | **string** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk'] 7 | **to** | **string** | Recipient fax number in E.164 format. | 8 | **list_id** | **int** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional] 9 | **from** | **string** | Your sender id. Must be a valid fax number. | [optional] 10 | **schedule** | **int** | Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp | [optional] 11 | **custom_string** | **string** | Your reference. Will be passed back with all replies and delivery reports. | [optional] 12 | **country** | **string** | Recipient country. | [optional] 13 | **from_email** | **string** | An email address where the reply should be emailed to. | [optional] 14 | 15 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 16 | 17 | -------------------------------------------------------------------------------- /docs/Model/FaxMessageCollection.md: -------------------------------------------------------------------------------- 1 | # FaxMessageCollection 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **messages** | [**\ClickSend\Model\FaxMessage[]**](FaxMessage.md) | Array of FaxMessage items | 7 | **file_url** | **string** | URL of file to send | 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/Fields.md: -------------------------------------------------------------------------------- 1 | # Fields 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **fields** | [**\ClickSend\Model\FieldsFields**](FieldsFields.md) | | [optional] 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/FieldsFields.md: -------------------------------------------------------------------------------- 1 | # FieldsFields 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **phone_number** | **string** | Your phone number in E.164 format. Must be provided if no fax number or email. | [optional] 7 | **custom_1** | **string** | | [optional] 8 | **email** | **string** | Your email. Must be provided if no phone number or fax number. | [optional] 9 | **fax_number** | **string** | Your fax number. Must be provided if no phone number or email. | [optional] 10 | **first_name** | **string** | Your first name. | [optional] 11 | **address_line_1** | **string** | Your street address | [optional] 12 | **address_line_2** | **string** | | [optional] 13 | **address_city** | **string** | Your nearest city | [optional] 14 | **address_state** | **string** | Your current state | [optional] 15 | **address_postal_code** | **string** | Your current postcode | [optional] 16 | **address_country** | **string** | Your current country | [optional] 17 | **organization_name** | **string** | Your organisation name | [optional] 18 | **custom_2** | **string** | | [optional] 19 | **custom_3** | **string** | | [optional] 20 | **custom_4** | **string** | | [optional] 21 | **last_name** | **string** | Your last name | [optional] 22 | 23 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 24 | 25 | -------------------------------------------------------------------------------- /docs/Model/ForgotPassword.md: -------------------------------------------------------------------------------- 1 | # ForgotPassword 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **username** | **string** | Username belonging to account. | 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/ForgotUsername.md: -------------------------------------------------------------------------------- 1 | # ForgotUsername 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **string** | Email belonging to account. | [optional] 7 | **phone_number** | **string** | Phone number belonging to account. | [optional] 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/InboundFaxRule.md: -------------------------------------------------------------------------------- 1 | # InboundFaxRule 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **dedicated_number** | **string** | Dedicated Number. Can be '*' to apply to all numbers. | 7 | **rule_name** | **string** | Rule Name. | 8 | **action** | **string** | Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE). | 9 | **action_address** | **string** | Action address. | 10 | **enabled** | **float** | Enabled: Disabled=0 or Enabled=1. | 11 | 12 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InboundSMSRule.md: -------------------------------------------------------------------------------- 1 | # InboundSMSRule 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **dedicated_number** | **string** | Dedicated Number. Can be '*' to apply to all numbers. | 7 | **rule_name** | **string** | Rule Name. | 8 | **message_search_type** | **float** | Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain. | 9 | **message_search_term** | **string** | Message search term. | 10 | **action** | **string** | Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE). | 11 | **action_address** | **string** | Action address. | 12 | **enabled** | **float** | Enabled: Disabled=0 or Enabled=1. | 13 | **webhook_type** | **string** | post, get, or json. post by default | [optional] 14 | 15 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 16 | 17 | -------------------------------------------------------------------------------- /docs/Model/MmsCampaign.md: -------------------------------------------------------------------------------- 1 | # MmsCampaign 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **list_id** | **int** | Your list id. | 7 | **name** | **string** | Your campaign name. | 8 | **body** | **string** | Your campaign message. | 9 | **from** | **string** | Your sender id - more info: http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number. | [optional] 10 | **schedule** | **int** | Your schedule timestamp. | [optional] [default to 0] 11 | **subject** | **string** | Subject of MMS campaign. | 12 | **media_file** | **string** | URL pointing to media file. | 13 | 14 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 15 | 16 | -------------------------------------------------------------------------------- /docs/Model/MmsMessage.md: -------------------------------------------------------------------------------- 1 | # MmsMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **to** | **string** | Recipient phone number in E.164 format | [optional] 7 | **body** | **string** | Your message | 8 | **subject** | **string** | Subject line (max 20 characters) | 9 | **from** | **string** | Your sender ID | [optional] 10 | **country** | **string** | Recipient country | [optional] 11 | **source** | **string** | Your method of sending | [optional] [default to 'sdk'] 12 | **list_id** | **int** | Your list ID if sending to a whole list (can be used instead of 'to') | [optional] 13 | **schedule** | **int** | Schedule time in unix format (leave blank for immediate delivery) | [optional] [default to 0] 14 | **custom_string** | **string** | Custom string for your reference | [optional] 15 | **from_email** | **string** | Email to send replies to | [optional] 16 | 17 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 18 | 19 | -------------------------------------------------------------------------------- /docs/Model/MmsMessageCollection.md: -------------------------------------------------------------------------------- 1 | # MmsMessageCollection 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **media_file** | **string** | Media file you want to send | 7 | **messages** | [**\ClickSend\Model\MmsMessage[]**](MmsMessage.md) | Array of MmsMessage models | 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/PostLetter.md: -------------------------------------------------------------------------------- 1 | # PostLetter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **file_url** | **string** | URL of file to send | 7 | **priority_post** | **int** | Whether letter is priority | [optional] [default to 0] 8 | **recipients** | [**\ClickSend\Model\PostRecipient[]**](PostRecipient.md) | Array of PostRecipient models | 9 | **template_used** | **int** | Whether using our template | [optional] [default to 0] 10 | **duplex** | **int** | Whether letter is duplex | [optional] [default to 0] 11 | **colour** | **int** | Whether letter is in colour | [optional] [default to 0] 12 | **source** | **string** | Source being sent from | [optional] [default to 'sdk'] 13 | 14 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 15 | 16 | -------------------------------------------------------------------------------- /docs/Model/PostPostcard.md: -------------------------------------------------------------------------------- 1 | # PostPostcard 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **file_urls** | **string[]** | Postcard file URLs | 7 | **recipients** | [**\ClickSend\Model\PostRecipient[]**](PostRecipient.md) | Array of recipients | 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/PostRecipient.md: -------------------------------------------------------------------------------- 1 | # PostRecipient 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **address_name** | **string** | Name of address | 7 | **address_line_1** | **string** | First line of address | 8 | **address_line_2** | **string** | Second line of address | [optional] 9 | **address_city** | **string** | City | 10 | **address_state** | **string** | State | 11 | **address_postal_code** | **string** | Postal code | 12 | **address_country** | **string** | Country | 13 | **return_address_id** | **int** | ID of return address to use | 14 | **schedule** | **int** | When to send letter (0/null=now) | [optional] [default to 0] 15 | 16 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 17 | 18 | -------------------------------------------------------------------------------- /docs/Model/ResellerAccount.md: -------------------------------------------------------------------------------- 1 | # ResellerAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **username** | **string** | Account username | 7 | **password** | **string** | Account password (unhashed) | 8 | **user_email** | **string** | Account email | 9 | **user_phone** | **string** | Account phone number | 10 | **user_first_name** | **string** | Account owner first name | 11 | **user_last_name** | **string** | Account owner last name | 12 | **account_name** | **string** | Account name (usually company name) | 13 | **country** | **string** | Country of account holder | 14 | 15 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 16 | 17 | -------------------------------------------------------------------------------- /docs/Model/ResellerAccountTransferCredit.md: -------------------------------------------------------------------------------- 1 | # ResellerAccountTransferCredit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **client_user_id** | **int** | User ID of client | 7 | **balance** | **int** | Balance to transfer | 8 | **currency** | **string** | Currency of balance to transfer | 9 | 10 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/SmsCampaign.md: -------------------------------------------------------------------------------- 1 | # SmsCampaign 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **list_id** | **int** | Your list id. | 7 | **name** | **string** | Your campaign name. | 8 | **body** | **string** | Your campaign message. | 9 | **from** | **string** | Your sender id - more info: http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number. | [optional] 10 | **schedule** | **int** | Your schedule timestamp. | [optional] [default to 0] 11 | **url_to_shorten** | **string** | url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder. | [optional] 12 | 13 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 14 | 15 | -------------------------------------------------------------------------------- /docs/Model/SmsMessage.md: -------------------------------------------------------------------------------- 1 | # SmsMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **from** | **string** | Your sender id - more info: http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number. | [optional] 7 | **body** | **string** | Your message. | 8 | **to** | **string** | Recipient phone number in E.164 format. | [optional] 9 | **source** | **string** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk'] 10 | **schedule** | **int** | Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp | [optional] [default to 0] 11 | **custom_string** | **string** | Your reference. Will be passed back with all replies and delivery reports. | [optional] 12 | **list_id** | **int** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional] 13 | **country** | **string** | Recipient country. | [optional] 14 | **from_email** | **string** | An email address where the reply should be emailed to. If omitted, the reply will be emailed back to the user who sent the outgoing SMS. | [optional] 15 | 16 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 17 | 18 | -------------------------------------------------------------------------------- /docs/Model/SmsMessageCollection.md: -------------------------------------------------------------------------------- 1 | # SmsMessageCollection 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **messages** | [**\ClickSend\Model\SmsMessage[]**](SmsMessage.md) | Array of SmsMessage items | 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/SmsTemplate.md: -------------------------------------------------------------------------------- 1 | # SmsTemplate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **template_name** | **string** | Name of template | 7 | **body** | **string** | Body of template | 8 | 9 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/StrippedString.md: -------------------------------------------------------------------------------- 1 | # StrippedString 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **strip_string** | **string** | String to be. | 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/Subaccount.md: -------------------------------------------------------------------------------- 1 | # Subaccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **api_username** | **string** | Your new api username. | 7 | **password** | **string** | Your new password | 8 | **email** | **string** | Your new email. | 9 | **phone_number** | **string** | Your phone number in E.164 format. | 10 | **first_name** | **string** | Your firstname | 11 | **last_name** | **string** | Your lastname | 12 | **access_users** | **int** | Your access users flag value, must be 1 or 0. | [optional] [default to 1] 13 | **access_billing** | **int** | Your access billing flag value, must be 1 or 0. | [optional] [default to 1] 14 | **access_reporting** | **int** | Your access reporting flag value, must be 1 or 0. | [optional] [default to 1] 15 | **access_contacts** | **int** | Your access contacts flag value, must be 1 or 0. | [optional] [default to 0] 16 | **access_settings** | **int** | Your access settings flag value, must be 1 or 0. | [optional] [default to 1] 17 | 18 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 19 | 20 | -------------------------------------------------------------------------------- /docs/Model/UploadFile.md: -------------------------------------------------------------------------------- 1 | # UploadFile 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content** | **string** | Your base64 encoded file string. | 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/Url.md: -------------------------------------------------------------------------------- 1 | # Url 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **string** | Your url. | 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /docs/Model/VoiceMessage.md: -------------------------------------------------------------------------------- 1 | # VoiceMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **to** | **string** | Your phone number in E.164 format. | [optional] 7 | **body** | **string** | Biscuit uv3nlCOjRk croissant chocolate lollipop chocolate muffin. | 8 | **voice** | **string** | Either 'female' or 'male'. | 9 | **custom_string** | **string** | Your reference. Will be passed back with all replies and delivery reports. | 10 | **country** | **string** | The country of the recipient. | 11 | **source** | **string** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk'] 12 | **list_id** | **int** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional] 13 | **lang** | **string** | au (string, required) - See section on available languages. | [optional] 14 | **schedule** | **int** | Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp | [optional] 15 | **require_input** | **int** | Whether you want to receive a keypress from the call recipient | [optional] [default to 0] 16 | **machine_detection** | **int** | Whether to attempt to detect an answering machine or voicemail service and leave a message | [optional] [default to 0] 17 | 18 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 19 | 20 | -------------------------------------------------------------------------------- /docs/Model/VoiceMessageCollection.md: -------------------------------------------------------------------------------- 1 | # VoiceMessageCollection 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **messages** | [**\ClickSend\Model\VoiceMessage[]**](VoiceMessage.md) | Array of VoiceMessage items | 7 | 8 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) 9 | 10 | -------------------------------------------------------------------------------- /lib/Model/ModelInterface.php: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 10 | ./test/Api 11 | ./test/Model 12 | 13 | 14 | 15 | 16 | 17 | ./lib/Api 18 | ./lib/Model 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /test/Api/CountriesApiTest.php: -------------------------------------------------------------------------------- 1 |